// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
pub(crate) client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
pub(crate) conf: crate::Config,
}
/// Client for Amazon Cognito Identity Provider
///
/// Client for invoking operations on Amazon Cognito Identity Provider. Each operation on Amazon Cognito Identity Provider is a method on this
/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
///
/// # Examples
/// **Constructing a client and invoking an operation**
/// ```rust,no_run
/// # async fn docs() {
/// // create a shared configuration. This can be used & shared between multiple service clients.
/// let shared_config = aws_config::load_from_env().await;
/// let client = aws_sdk_cognitoidentityprovider::Client::new(&shared_config);
/// // invoke an operation
/// /* let rsp = client
/// .<operation_name>().
/// .<param>("some value")
/// .send().await; */
/// # }
/// ```
/// **Constructing a client with custom configuration**
/// ```rust,no_run
/// use aws_config::retry::RetryConfig;
/// # async fn docs() {
/// let shared_config = aws_config::load_from_env().await;
/// let config = aws_sdk_cognitoidentityprovider::config::Builder::from(&shared_config)
/// .retry_config(RetryConfig::disabled())
/// .build();
/// let client = aws_sdk_cognitoidentityprovider::Client::from_conf(config);
/// # }
#[derive(std::fmt::Debug)]
pub struct Client {
handle: std::sync::Arc<Handle>,
}
impl std::clone::Clone for Client {
fn clone(&self) -> Self {
Self {
handle: self.handle.clone(),
}
}
}
#[doc(inline)]
pub use aws_smithy_client::Builder;
impl
From<
aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
> for Client
{
fn from(
client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
) -> Self {
Self::with_config(client, crate::Config::builder().build())
}
}
impl Client {
/// Creates a client with the given service configuration.
pub fn with_config(
client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
conf: crate::Config,
) -> Self {
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
/// Returns the client's configuration.
pub fn conf(&self) -> &crate::Config {
&self.handle.conf
}
}
impl Client {
/// Constructs a fluent builder for the [`AddCustomAttributes`](crate::client::fluent_builders::AddCustomAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AddCustomAttributes::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AddCustomAttributes::set_user_pool_id): <p>The user pool ID for the user pool where you want to add custom attributes.</p>
/// - [`custom_attributes(Vec<SchemaAttributeType>)`](crate::client::fluent_builders::AddCustomAttributes::custom_attributes) / [`set_custom_attributes(Option<Vec<SchemaAttributeType>>)`](crate::client::fluent_builders::AddCustomAttributes::set_custom_attributes): <p>An array of custom attributes, such as Mutable and Name.</p>
/// - On success, responds with [`AddCustomAttributesOutput`](crate::output::AddCustomAttributesOutput)
/// - On failure, responds with [`SdkError<AddCustomAttributesError>`](crate::error::AddCustomAttributesError)
pub fn add_custom_attributes(&self) -> fluent_builders::AddCustomAttributes {
fluent_builders::AddCustomAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminAddUserToGroup`](crate::client::fluent_builders::AdminAddUserToGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminAddUserToGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminAddUserToGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminAddUserToGroup::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminAddUserToGroup::set_username): <p>The username for the user.</p>
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::AdminAddUserToGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::AdminAddUserToGroup::set_group_name): <p>The group name.</p>
/// - On success, responds with [`AdminAddUserToGroupOutput`](crate::output::AdminAddUserToGroupOutput)
/// - On failure, responds with [`SdkError<AdminAddUserToGroupError>`](crate::error::AdminAddUserToGroupError)
pub fn admin_add_user_to_group(&self) -> fluent_builders::AdminAddUserToGroup {
fluent_builders::AdminAddUserToGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminConfirmSignUp`](crate::client::fluent_builders::AdminConfirmSignUp) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminConfirmSignUp::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminConfirmSignUp::set_user_pool_id): <p>The user pool ID for which you want to confirm user registration.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminConfirmSignUp::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminConfirmSignUp::set_username): <p>The user name for which you want to confirm user registration.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::AdminConfirmSignUp::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminConfirmSignUp::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the <code>clientMetadata</code> attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`AdminConfirmSignUpOutput`](crate::output::AdminConfirmSignUpOutput)
/// - On failure, responds with [`SdkError<AdminConfirmSignUpError>`](crate::error::AdminConfirmSignUpError)
pub fn admin_confirm_sign_up(&self) -> fluent_builders::AdminConfirmSignUp {
fluent_builders::AdminConfirmSignUp::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminCreateUser`](crate::client::fluent_builders::AdminCreateUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminCreateUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminCreateUser::set_user_pool_id): <p>The user pool ID for the user pool where the user will be created.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminCreateUser::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminCreateUser::set_username): <p>The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.</p>
/// - [`user_attributes(Vec<AttributeType>)`](crate::client::fluent_builders::AdminCreateUser::user_attributes) / [`set_user_attributes(Option<Vec<AttributeType>>)`](crate::client::fluent_builders::AdminCreateUser::set_user_attributes): <p>An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than <code>Username</code>. However, any attributes that you specify as required (when creating a user pool or in the <b>Attributes</b> tab of the console) either you should supply (in your call to <code>AdminCreateUser</code>) or the user should supply (when they sign up in response to your welcome message).</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p> <p>To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the <b>Users</b> tab of the Amazon Cognito console for managing your user pools.</p> <p>In your call to <code>AdminCreateUser</code>, you can set the <code>email_verified</code> attribute to <code>True</code>, and you can set the <code>phone_number_verified</code> attribute to <code>True</code>. You can also do this by calling <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a>.</p> <ul> <li> <p> <b>email</b>: The email address of the user to whom the message that contains the code and username will be sent. Required if the <code>email_verified</code> attribute is set to <code>True</code>, or if <code>"EMAIL"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li> <li> <p> <b>phone_number</b>: The phone number of the user to whom the message that contains the code and username will be sent. Required if the <code>phone_number_verified</code> attribute is set to <code>True</code>, or if <code>"SMS"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li> </ul>
/// - [`validation_data(Vec<AttributeType>)`](crate::client::fluent_builders::AdminCreateUser::validation_data) / [`set_validation_data(Option<Vec<AttributeType>>)`](crate::client::fluent_builders::AdminCreateUser::set_validation_data): <p>The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.</p> <p>To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.</p> <p>The user's validation data isn't persisted.</p>
/// - [`temporary_password(impl Into<String>)`](crate::client::fluent_builders::AdminCreateUser::temporary_password) / [`set_temporary_password(Option<String>)`](crate::client::fluent_builders::AdminCreateUser::set_temporary_password): <p>The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.</p> <p>The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.</p> <p>This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.</p> <p>The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter.</p>
/// - [`force_alias_creation(bool)`](crate::client::fluent_builders::AdminCreateUser::force_alias_creation) / [`set_force_alias_creation(bool)`](crate::client::fluent_builders::AdminCreateUser::set_force_alias_creation): <p>This parameter is used only if the <code>phone_number_verified</code> or <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is ignored.</p> <p>If this parameter is set to <code>True</code> and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.</p> <p>If this parameter is set to <code>False</code>, the API throws an <code>AliasExistsException</code> error if the alias already exists. The default value is <code>False</code>.</p>
/// - [`message_action(MessageActionType)`](crate::client::fluent_builders::AdminCreateUser::message_action) / [`set_message_action(Option<MessageActionType>)`](crate::client::fluent_builders::AdminCreateUser::set_message_action): <p>Set to <code>RESEND</code> to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to <code>SUPPRESS</code> to suppress sending the message. You can specify only one value.</p>
/// - [`desired_delivery_mediums(Vec<DeliveryMediumType>)`](crate::client::fluent_builders::AdminCreateUser::desired_delivery_mediums) / [`set_desired_delivery_mediums(Option<Vec<DeliveryMediumType>>)`](crate::client::fluent_builders::AdminCreateUser::set_desired_delivery_mediums): <p>Specify <code>"EMAIL"</code> if email will be used to send the welcome message. Specify <code>"SMS"</code> if the phone number will be used. The default value is <code>"SMS"</code>. You can specify more than one value.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::AdminCreateUser::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminCreateUser::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`AdminCreateUserOutput`](crate::output::AdminCreateUserOutput) with field(s):
/// - [`user(Option<UserType>)`](crate::output::AdminCreateUserOutput::user): <p>The newly created user.</p>
/// - On failure, responds with [`SdkError<AdminCreateUserError>`](crate::error::AdminCreateUserError)
pub fn admin_create_user(&self) -> fluent_builders::AdminCreateUser {
fluent_builders::AdminCreateUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminDeleteUser`](crate::client::fluent_builders::AdminDeleteUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminDeleteUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminDeleteUser::set_user_pool_id): <p>The user pool ID for the user pool where you want to delete the user.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminDeleteUser::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminDeleteUser::set_username): <p>The user name of the user you want to delete.</p>
/// - On success, responds with [`AdminDeleteUserOutput`](crate::output::AdminDeleteUserOutput)
/// - On failure, responds with [`SdkError<AdminDeleteUserError>`](crate::error::AdminDeleteUserError)
pub fn admin_delete_user(&self) -> fluent_builders::AdminDeleteUser {
fluent_builders::AdminDeleteUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminDeleteUserAttributes`](crate::client::fluent_builders::AdminDeleteUserAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminDeleteUserAttributes::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminDeleteUserAttributes::set_user_pool_id): <p>The user pool ID for the user pool where you want to delete user attributes.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminDeleteUserAttributes::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminDeleteUserAttributes::set_username): <p>The user name of the user from which you would like to delete attributes.</p>
/// - [`user_attribute_names(Vec<String>)`](crate::client::fluent_builders::AdminDeleteUserAttributes::user_attribute_names) / [`set_user_attribute_names(Option<Vec<String>>)`](crate::client::fluent_builders::AdminDeleteUserAttributes::set_user_attribute_names): <p>An array of strings representing the user attribute names you want to delete.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// - On success, responds with [`AdminDeleteUserAttributesOutput`](crate::output::AdminDeleteUserAttributesOutput)
/// - On failure, responds with [`SdkError<AdminDeleteUserAttributesError>`](crate::error::AdminDeleteUserAttributesError)
pub fn admin_delete_user_attributes(&self) -> fluent_builders::AdminDeleteUserAttributes {
fluent_builders::AdminDeleteUserAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminDisableProviderForUser`](crate::client::fluent_builders::AdminDisableProviderForUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminDisableProviderForUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminDisableProviderForUser::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`user(ProviderUserIdentifierType)`](crate::client::fluent_builders::AdminDisableProviderForUser::user) / [`set_user(Option<ProviderUserIdentifierType>)`](crate::client::fluent_builders::AdminDisableProviderForUser::set_user): <p>The user to be disabled.</p>
/// - On success, responds with [`AdminDisableProviderForUserOutput`](crate::output::AdminDisableProviderForUserOutput)
/// - On failure, responds with [`SdkError<AdminDisableProviderForUserError>`](crate::error::AdminDisableProviderForUserError)
pub fn admin_disable_provider_for_user(&self) -> fluent_builders::AdminDisableProviderForUser {
fluent_builders::AdminDisableProviderForUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminDisableUser`](crate::client::fluent_builders::AdminDisableUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminDisableUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminDisableUser::set_user_pool_id): <p>The user pool ID for the user pool where you want to disable the user.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminDisableUser::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminDisableUser::set_username): <p>The user name of the user you want to disable.</p>
/// - On success, responds with [`AdminDisableUserOutput`](crate::output::AdminDisableUserOutput)
/// - On failure, responds with [`SdkError<AdminDisableUserError>`](crate::error::AdminDisableUserError)
pub fn admin_disable_user(&self) -> fluent_builders::AdminDisableUser {
fluent_builders::AdminDisableUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminEnableUser`](crate::client::fluent_builders::AdminEnableUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminEnableUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminEnableUser::set_user_pool_id): <p>The user pool ID for the user pool where you want to enable the user.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminEnableUser::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminEnableUser::set_username): <p>The user name of the user you want to enable.</p>
/// - On success, responds with [`AdminEnableUserOutput`](crate::output::AdminEnableUserOutput)
/// - On failure, responds with [`SdkError<AdminEnableUserError>`](crate::error::AdminEnableUserError)
pub fn admin_enable_user(&self) -> fluent_builders::AdminEnableUser {
fluent_builders::AdminEnableUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminForgetDevice`](crate::client::fluent_builders::AdminForgetDevice) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminForgetDevice::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminForgetDevice::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminForgetDevice::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminForgetDevice::set_username): <p>The user name.</p>
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::AdminForgetDevice::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::AdminForgetDevice::set_device_key): <p>The device key.</p>
/// - On success, responds with [`AdminForgetDeviceOutput`](crate::output::AdminForgetDeviceOutput)
/// - On failure, responds with [`SdkError<AdminForgetDeviceError>`](crate::error::AdminForgetDeviceError)
pub fn admin_forget_device(&self) -> fluent_builders::AdminForgetDevice {
fluent_builders::AdminForgetDevice::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminGetDevice`](crate::client::fluent_builders::AdminGetDevice) operation.
///
/// - The fluent builder is configurable:
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::AdminGetDevice::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::AdminGetDevice::set_device_key): <p>The device key.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminGetDevice::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminGetDevice::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminGetDevice::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminGetDevice::set_username): <p>The user name.</p>
/// - On success, responds with [`AdminGetDeviceOutput`](crate::output::AdminGetDeviceOutput) with field(s):
/// - [`device(Option<DeviceType>)`](crate::output::AdminGetDeviceOutput::device): <p>The device.</p>
/// - On failure, responds with [`SdkError<AdminGetDeviceError>`](crate::error::AdminGetDeviceError)
pub fn admin_get_device(&self) -> fluent_builders::AdminGetDevice {
fluent_builders::AdminGetDevice::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminGetUser`](crate::client::fluent_builders::AdminGetUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminGetUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminGetUser::set_user_pool_id): <p>The user pool ID for the user pool where you want to get information about the user.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminGetUser::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminGetUser::set_username): <p>The user name of the user you want to retrieve.</p>
/// - On success, responds with [`AdminGetUserOutput`](crate::output::AdminGetUserOutput) with field(s):
/// - [`username(Option<String>)`](crate::output::AdminGetUserOutput::username): <p>The user name of the user about whom you're receiving information.</p>
/// - [`user_attributes(Option<Vec<AttributeType>>)`](crate::output::AdminGetUserOutput::user_attributes): <p>An array of name-value pairs representing user attributes.</p>
/// - [`user_create_date(Option<DateTime>)`](crate::output::AdminGetUserOutput::user_create_date): <p>The date the user was created.</p>
/// - [`user_last_modified_date(Option<DateTime>)`](crate::output::AdminGetUserOutput::user_last_modified_date): <p>The date the user was last modified.</p>
/// - [`enabled(bool)`](crate::output::AdminGetUserOutput::enabled): <p>Indicates that the status is <code>enabled</code>.</p>
/// - [`user_status(Option<UserStatusType>)`](crate::output::AdminGetUserOutput::user_status): <p>The user status. Can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>
/// - [`mfa_options(Option<Vec<MfaOptionType>>)`](crate::output::AdminGetUserOutput::mfa_options): <p> <i>This response parameter is no longer supported.</i> It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.</p>
/// - [`preferred_mfa_setting(Option<String>)`](crate::output::AdminGetUserOutput::preferred_mfa_setting): <p>The user's preferred MFA setting.</p>
/// - [`user_mfa_setting_list(Option<Vec<String>>)`](crate::output::AdminGetUserOutput::user_mfa_setting_list): <p>The MFA options that are activated for the user. The possible values in this list are <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
/// - On failure, responds with [`SdkError<AdminGetUserError>`](crate::error::AdminGetUserError)
pub fn admin_get_user(&self) -> fluent_builders::AdminGetUser {
fluent_builders::AdminGetUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminInitiateAuth`](crate::client::fluent_builders::AdminInitiateAuth) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminInitiateAuth::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminInitiateAuth::set_user_pool_id): <p>The ID of the Amazon Cognito user pool.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::AdminInitiateAuth::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::AdminInitiateAuth::set_client_id): <p>The app client ID.</p>
/// - [`auth_flow(AuthFlowType)`](crate::client::fluent_builders::AdminInitiateAuth::auth_flow) / [`set_auth_flow(Option<AuthFlowType>)`](crate::client::fluent_builders::AdminInitiateAuth::set_auth_flow): <p>The authentication flow for this call to run. The API action will depend on this value. For example:</p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p> </li> <li> <p> <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and <code>SRP_A</code> and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.</p> </li> <li> <p> <code>ADMIN_USER_PASSWORD_AUTH</code> will take in <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li> <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.</p> </li> <li> <p> <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication. This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.</p> </li> </ul>
/// - [`auth_parameters(HashMap<String, String>)`](crate::client::fluent_builders::AdminInitiateAuth::auth_parameters) / [`set_auth_parameters(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminInitiateAuth::set_auth_parameters): <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you're invoking. The required values depend on the value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For <code>ADMIN_NO_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>PASSWORD</code> (required), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code>. To start the authentication flow with password verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The SRP_A Value)</code>.</p> </li> </ul>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::AdminInitiateAuth::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminInitiateAuth::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p> <ul> <li> <p>Pre signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p> </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p> <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::AdminInitiateAuth::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::AdminInitiateAuth::set_analytics_metadata): <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminInitiateAuth</code> calls.</p>
/// - [`context_data(ContextDataType)`](crate::client::fluent_builders::AdminInitiateAuth::context_data) / [`set_context_data(Option<ContextDataType>)`](crate::client::fluent_builders::AdminInitiateAuth::set_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - On success, responds with [`AdminInitiateAuthOutput`](crate::output::AdminInitiateAuthOutput) with field(s):
/// - [`challenge_name(Option<ChallengeNameType>)`](crate::output::AdminInitiateAuthOutput::challenge_name): <p>The name of the challenge that you're responding to with this call. This is returned in the <code>AdminInitiateAuth</code> response if you must pass another challenge.</p> <ul> <li> <p> <code>MFA_SETUP</code>: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an <code>MFA_SETUP</code> challenge. The user must set up at least one MFA type to continue to authenticate.</p> </li> <li> <p> <code>SELECT_MFA_TYPE</code>: Selects the MFA type. Valid MFA options are <code>SMS_MFA</code> for text SMS MFA, and <code>SOFTWARE_TOKEN_MFA</code> for time-based one-time password (TOTP) software token MFA.</p> </li> <li> <p> <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p> </li> <li> <p> <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code>: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: This is returned if you must authenticate with <code>USERNAME</code> and <code>PASSWORD</code> directly. An app client must be enabled to use this flow.</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their passwords after successful first login. Respond to this challenge with <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in the <code>requiredAttributes</code> parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p> <note> <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>AdminRespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p> </note> </li> <li> <p> <code>MFA_SETUP</code>: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters <code>MFA_CAN_SETUP</code> value. </p> <p> To set up software token MFA, use the session returned here from <code>InitiateAuth</code> as an input to <code>AssociateSoftwareToken</code>, and use the session returned by <code>VerifySoftwareToken</code> as an input to <code>RespondToAuthChallenge</code> with challenge name <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call <code>InitiateAuth</code> again to restart sign-in.</p> </li> </ul>
/// - [`session(Option<String>)`](crate::output::AdminInitiateAuthOutput::session): <p>The session that should be passed both ways in challenge-response calls to the service. If <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code> API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>AdminRespondToAuthChallenge</code> API call.</p>
/// - [`challenge_parameters(Option<HashMap<String, String>>)`](crate::output::AdminInitiateAuthOutput::challenge_parameters): <p>The challenge parameters. These are returned to you in the <code>AdminInitiateAuth</code> response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (<code>AdminRespondToAuthChallenge</code>).</p> <p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable).</p> <p>The value of the <code>USER_ID_FOR_SRP</code> attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to <code>AdminInitiateAuth</code>. This happens because, in the <code>AdminRespondToAuthChallenge</code> API <code>ChallengeResponses</code>, the <code>USERNAME</code> attribute can't be an alias.</p>
/// - [`authentication_result(Option<AuthenticationResultType>)`](crate::output::AdminInitiateAuthOutput::authentication_result): <p>The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
/// - On failure, responds with [`SdkError<AdminInitiateAuthError>`](crate::error::AdminInitiateAuthError)
pub fn admin_initiate_auth(&self) -> fluent_builders::AdminInitiateAuth {
fluent_builders::AdminInitiateAuth::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminLinkProviderForUser`](crate::client::fluent_builders::AdminLinkProviderForUser) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminLinkProviderForUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminLinkProviderForUser::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`destination_user(ProviderUserIdentifierType)`](crate::client::fluent_builders::AdminLinkProviderForUser::destination_user) / [`set_destination_user(Option<ProviderUserIdentifierType>)`](crate::client::fluent_builders::AdminLinkProviderForUser::set_destination_user): <p>The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.</p> <p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user, it should be the provider-specific <code>user_id</code>.</p> <p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p> <p>The <code>ProviderName</code> should be set to <code>Cognito</code> for users in Cognito user pools.</p> <important> <p>All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.</p> </important>
/// - [`source_user(ProviderUserIdentifierType)`](crate::client::fluent_builders::AdminLinkProviderForUser::source_user) / [`set_source_user(Option<ProviderUserIdentifierType>)`](crate::client::fluent_builders::AdminLinkProviderForUser::set_source_user): <p>An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.</p> <p>If the <code>SourceUser</code> is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>. For social IdPs, the <code>ProviderName</code> will be <code>Facebook</code>, <code>Google</code>, or <code>LoginWithAmazon</code>, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for <code>id</code>, <code>sub</code>, and <code>user_id</code>, respectively. The <code>ProviderAttributeValue</code> for the user must be the same value as the <code>id</code>, <code>sub</code>, or <code>user_id</code> value found in the social IdP token.</p> <p></p> <p>For SAML, the <code>ProviderAttributeName</code> can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the <code>ProviderAttributeName</code>. If you set <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.</p>
/// - On success, responds with [`AdminLinkProviderForUserOutput`](crate::output::AdminLinkProviderForUserOutput)
/// - On failure, responds with [`SdkError<AdminLinkProviderForUserError>`](crate::error::AdminLinkProviderForUserError)
pub fn admin_link_provider_for_user(&self) -> fluent_builders::AdminLinkProviderForUser {
fluent_builders::AdminLinkProviderForUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminListDevices`](crate::client::fluent_builders::AdminListDevices) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminListDevices::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminListDevices::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminListDevices::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminListDevices::set_username): <p>The user name.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::AdminListDevices::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::AdminListDevices::set_limit): <p>The limit of the devices request.</p>
/// - [`pagination_token(impl Into<String>)`](crate::client::fluent_builders::AdminListDevices::pagination_token) / [`set_pagination_token(Option<String>)`](crate::client::fluent_builders::AdminListDevices::set_pagination_token): <p>The pagination token.</p>
/// - On success, responds with [`AdminListDevicesOutput`](crate::output::AdminListDevicesOutput) with field(s):
/// - [`devices(Option<Vec<DeviceType>>)`](crate::output::AdminListDevicesOutput::devices): <p>The devices in the list of devices response.</p>
/// - [`pagination_token(Option<String>)`](crate::output::AdminListDevicesOutput::pagination_token): <p>The pagination token.</p>
/// - On failure, responds with [`SdkError<AdminListDevicesError>`](crate::error::AdminListDevicesError)
pub fn admin_list_devices(&self) -> fluent_builders::AdminListDevices {
fluent_builders::AdminListDevices::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminListGroupsForUser`](crate::client::fluent_builders::AdminListGroupsForUser) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::AdminListGroupsForUser::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminListGroupsForUser::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminListGroupsForUser::set_username): <p>The username for the user.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminListGroupsForUser::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminListGroupsForUser::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::AdminListGroupsForUser::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::AdminListGroupsForUser::set_limit): <p>The limit of the request to list groups.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::AdminListGroupsForUser::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::AdminListGroupsForUser::set_next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On success, responds with [`AdminListGroupsForUserOutput`](crate::output::AdminListGroupsForUserOutput) with field(s):
/// - [`groups(Option<Vec<GroupType>>)`](crate::output::AdminListGroupsForUserOutput::groups): <p>The groups that the user belongs to.</p>
/// - [`next_token(Option<String>)`](crate::output::AdminListGroupsForUserOutput::next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On failure, responds with [`SdkError<AdminListGroupsForUserError>`](crate::error::AdminListGroupsForUserError)
pub fn admin_list_groups_for_user(&self) -> fluent_builders::AdminListGroupsForUser {
fluent_builders::AdminListGroupsForUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminListUserAuthEvents`](crate::client::fluent_builders::AdminListUserAuthEvents) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::AdminListUserAuthEvents::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminListUserAuthEvents::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminListUserAuthEvents::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminListUserAuthEvents::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminListUserAuthEvents::set_username): <p>The user pool username or an alias.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::AdminListUserAuthEvents::max_results) / [`set_max_results(Option<i32>)`](crate::client::fluent_builders::AdminListUserAuthEvents::set_max_results): <p>The maximum number of authentication events to return. Returns 60 events if you set <code>MaxResults</code> to 0, or if you don't include a <code>MaxResults</code> parameter.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::AdminListUserAuthEvents::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::AdminListUserAuthEvents::set_next_token): <p>A pagination token.</p>
/// - On success, responds with [`AdminListUserAuthEventsOutput`](crate::output::AdminListUserAuthEventsOutput) with field(s):
/// - [`auth_events(Option<Vec<AuthEventType>>)`](crate::output::AdminListUserAuthEventsOutput::auth_events): <p>The response object. It includes the <code>EventID</code>, <code>EventType</code>, <code>CreationDate</code>, <code>EventRisk</code>, and <code>EventResponse</code>.</p>
/// - [`next_token(Option<String>)`](crate::output::AdminListUserAuthEventsOutput::next_token): <p>A pagination token.</p>
/// - On failure, responds with [`SdkError<AdminListUserAuthEventsError>`](crate::error::AdminListUserAuthEventsError)
pub fn admin_list_user_auth_events(&self) -> fluent_builders::AdminListUserAuthEvents {
fluent_builders::AdminListUserAuthEvents::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminRemoveUserFromGroup`](crate::client::fluent_builders::AdminRemoveUserFromGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminRemoveUserFromGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminRemoveUserFromGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminRemoveUserFromGroup::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminRemoveUserFromGroup::set_username): <p>The username for the user.</p>
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::AdminRemoveUserFromGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::AdminRemoveUserFromGroup::set_group_name): <p>The group name.</p>
/// - On success, responds with [`AdminRemoveUserFromGroupOutput`](crate::output::AdminRemoveUserFromGroupOutput)
/// - On failure, responds with [`SdkError<AdminRemoveUserFromGroupError>`](crate::error::AdminRemoveUserFromGroupError)
pub fn admin_remove_user_from_group(&self) -> fluent_builders::AdminRemoveUserFromGroup {
fluent_builders::AdminRemoveUserFromGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminResetUserPassword`](crate::client::fluent_builders::AdminResetUserPassword) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminResetUserPassword::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminResetUserPassword::set_user_pool_id): <p>The user pool ID for the user pool where you want to reset the user's password.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminResetUserPassword::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminResetUserPassword::set_username): <p>The user name of the user whose password you want to reset.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::AdminResetUserPassword::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminResetUserPassword::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`AdminResetUserPasswordOutput`](crate::output::AdminResetUserPasswordOutput)
/// - On failure, responds with [`SdkError<AdminResetUserPasswordError>`](crate::error::AdminResetUserPasswordError)
pub fn admin_reset_user_password(&self) -> fluent_builders::AdminResetUserPassword {
fluent_builders::AdminResetUserPassword::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminRespondToAuthChallenge`](crate::client::fluent_builders::AdminRespondToAuthChallenge) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_user_pool_id): <p>The ID of the Amazon Cognito user pool.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_client_id): <p>The app client ID.</p>
/// - [`challenge_name(ChallengeNameType)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::challenge_name) / [`set_challenge_name(Option<ChallengeNameType>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_challenge_name): <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
/// - [`challenge_responses(HashMap<String, String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::challenge_responses) / [`set_challenge_responses(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_challenge_responses): <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <ul> <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> <note> <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when signing in with a remembered device.</p> </note> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: <code>PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>AdminInitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren't required by your user pool.</p> <note> <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>AdminRespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p> </note> </li> <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li> </ul> <p>The value of the <code>USERNAME</code> attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the <code>AdminInitiateAuth</code> response includes the actual username value in the <code>USERNAMEUSER_ID_FOR_SRP</code> attribute. This happens even if you specified an alias in your call to <code>AdminInitiateAuth</code>.</p>
/// - [`session(impl Into<String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::session) / [`set_session(Option<String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_session): <p>The session that should be passed both ways in challenge-response calls to the service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_analytics_metadata): <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminRespondToAuthChallenge</code> calls.</p>
/// - [`context_data(ContextDataType)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::context_data) / [`set_context_data(Option<ContextDataType>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminRespondToAuthChallenge::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers: </p> <ul> <li> <p>pre sign-up</p> </li> <li> <p>custom message</p> </li> <li> <p>post authentication</p> </li> <li> <p>user migration</p> </li> <li> <p>pre token generation</p> </li> <li> <p>define auth challenge</p> </li> <li> <p>create auth challenge</p> </li> <li> <p>verify auth challenge response</p> </li> </ul> <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`AdminRespondToAuthChallengeOutput`](crate::output::AdminRespondToAuthChallengeOutput) with field(s):
/// - [`challenge_name(Option<ChallengeNameType>)`](crate::output::AdminRespondToAuthChallengeOutput::challenge_name): <p>The name of the challenge. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
/// - [`session(Option<String>)`](crate::output::AdminRespondToAuthChallengeOutput::session): <p>The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
/// - [`challenge_parameters(Option<HashMap<String, String>>)`](crate::output::AdminRespondToAuthChallengeOutput::challenge_parameters): <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
/// - [`authentication_result(Option<AuthenticationResultType>)`](crate::output::AdminRespondToAuthChallengeOutput::authentication_result): <p>The result returned by the server in response to the authentication request.</p>
/// - On failure, responds with [`SdkError<AdminRespondToAuthChallengeError>`](crate::error::AdminRespondToAuthChallengeError)
pub fn admin_respond_to_auth_challenge(&self) -> fluent_builders::AdminRespondToAuthChallenge {
fluent_builders::AdminRespondToAuthChallenge::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminSetUserMFAPreference`](crate::client::fluent_builders::AdminSetUserMFAPreference) operation.
///
/// - The fluent builder is configurable:
/// - [`sms_mfa_settings(SmsMfaSettingsType)`](crate::client::fluent_builders::AdminSetUserMFAPreference::sms_mfa_settings) / [`set_sms_mfa_settings(Option<SmsMfaSettingsType>)`](crate::client::fluent_builders::AdminSetUserMFAPreference::set_sms_mfa_settings): <p>The SMS text message MFA settings.</p>
/// - [`software_token_mfa_settings(SoftwareTokenMfaSettingsType)`](crate::client::fluent_builders::AdminSetUserMFAPreference::software_token_mfa_settings) / [`set_software_token_mfa_settings(Option<SoftwareTokenMfaSettingsType>)`](crate::client::fluent_builders::AdminSetUserMFAPreference::set_software_token_mfa_settings): <p>The time-based one-time password software token MFA settings.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserMFAPreference::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminSetUserMFAPreference::set_username): <p>The user pool username or alias.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserMFAPreference::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminSetUserMFAPreference::set_user_pool_id): <p>The user pool ID.</p>
/// - On success, responds with [`AdminSetUserMfaPreferenceOutput`](crate::output::AdminSetUserMfaPreferenceOutput)
/// - On failure, responds with [`SdkError<AdminSetUserMFAPreferenceError>`](crate::error::AdminSetUserMFAPreferenceError)
pub fn admin_set_user_mfa_preference(&self) -> fluent_builders::AdminSetUserMFAPreference {
fluent_builders::AdminSetUserMFAPreference::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminSetUserPassword`](crate::client::fluent_builders::AdminSetUserPassword) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserPassword::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminSetUserPassword::set_user_pool_id): <p>The user pool ID for the user pool where you want to set the user's password.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserPassword::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminSetUserPassword::set_username): <p>The user name of the user whose password you want to set.</p>
/// - [`password(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserPassword::password) / [`set_password(Option<String>)`](crate::client::fluent_builders::AdminSetUserPassword::set_password): <p>The password for the user.</p>
/// - [`permanent(bool)`](crate::client::fluent_builders::AdminSetUserPassword::permanent) / [`set_permanent(bool)`](crate::client::fluent_builders::AdminSetUserPassword::set_permanent): <p> <code>True</code> if the password is permanent, <code>False</code> if it is temporary.</p>
/// - On success, responds with [`AdminSetUserPasswordOutput`](crate::output::AdminSetUserPasswordOutput)
/// - On failure, responds with [`SdkError<AdminSetUserPasswordError>`](crate::error::AdminSetUserPasswordError)
pub fn admin_set_user_password(&self) -> fluent_builders::AdminSetUserPassword {
fluent_builders::AdminSetUserPassword::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminSetUserSettings`](crate::client::fluent_builders::AdminSetUserSettings) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserSettings::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminSetUserSettings::set_user_pool_id): <p>The ID of the user pool that contains the user whose options you're setting.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminSetUserSettings::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminSetUserSettings::set_username): <p>The user name of the user whose options you're setting.</p>
/// - [`mfa_options(Vec<MfaOptionType>)`](crate::client::fluent_builders::AdminSetUserSettings::mfa_options) / [`set_mfa_options(Option<Vec<MfaOptionType>>)`](crate::client::fluent_builders::AdminSetUserSettings::set_mfa_options): <p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>
/// - On success, responds with [`AdminSetUserSettingsOutput`](crate::output::AdminSetUserSettingsOutput)
/// - On failure, responds with [`SdkError<AdminSetUserSettingsError>`](crate::error::AdminSetUserSettingsError)
pub fn admin_set_user_settings(&self) -> fluent_builders::AdminSetUserSettings {
fluent_builders::AdminSetUserSettings::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminUpdateAuthEventFeedback`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::set_username): <p>The user pool username.</p>
/// - [`event_id(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::event_id) / [`set_event_id(Option<String>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::set_event_id): <p>The authentication event ID.</p>
/// - [`feedback_value(FeedbackValueType)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::feedback_value) / [`set_feedback_value(Option<FeedbackValueType>)`](crate::client::fluent_builders::AdminUpdateAuthEventFeedback::set_feedback_value): <p>The authentication event feedback value.</p>
/// - On success, responds with [`AdminUpdateAuthEventFeedbackOutput`](crate::output::AdminUpdateAuthEventFeedbackOutput)
/// - On failure, responds with [`SdkError<AdminUpdateAuthEventFeedbackError>`](crate::error::AdminUpdateAuthEventFeedbackError)
pub fn admin_update_auth_event_feedback(
&self,
) -> fluent_builders::AdminUpdateAuthEventFeedback {
fluent_builders::AdminUpdateAuthEventFeedback::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminUpdateDeviceStatus`](crate::client::fluent_builders::AdminUpdateDeviceStatus) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::set_username): <p>The user name.</p>
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::set_device_key): <p>The device key.</p>
/// - [`device_remembered_status(DeviceRememberedStatusType)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::device_remembered_status) / [`set_device_remembered_status(Option<DeviceRememberedStatusType>)`](crate::client::fluent_builders::AdminUpdateDeviceStatus::set_device_remembered_status): <p>The status indicating whether a device has been remembered or not.</p>
/// - On success, responds with [`AdminUpdateDeviceStatusOutput`](crate::output::AdminUpdateDeviceStatusOutput)
/// - On failure, responds with [`SdkError<AdminUpdateDeviceStatusError>`](crate::error::AdminUpdateDeviceStatusError)
pub fn admin_update_device_status(&self) -> fluent_builders::AdminUpdateDeviceStatus {
fluent_builders::AdminUpdateDeviceStatus::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminUpdateUserAttributes`](crate::client::fluent_builders::AdminUpdateUserAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::set_user_pool_id): <p>The user pool ID for the user pool where you want to update user attributes.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::set_username): <p>The user name of the user for whom you want to update user attributes.</p>
/// - [`user_attributes(Vec<AttributeType>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::user_attributes) / [`set_user_attributes(Option<Vec<AttributeType>>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::set_user_attributes): <p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p> <p>If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.</p> <p>To update the value of an attribute that requires verification in the same API request, include the <code>email_verified</code> or <code>phone_number_verified</code> attribute, with a value of <code>true</code>. If you set the <code>email_verified</code> or <code>phone_number_verified</code> value for an <code>email</code> or <code>phone_number</code> attribute that requires verification to <code>true</code>, Amazon Cognito doesn’t send a verification message to your user.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::AdminUpdateUserAttributes::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`AdminUpdateUserAttributesOutput`](crate::output::AdminUpdateUserAttributesOutput)
/// - On failure, responds with [`SdkError<AdminUpdateUserAttributesError>`](crate::error::AdminUpdateUserAttributesError)
pub fn admin_update_user_attributes(&self) -> fluent_builders::AdminUpdateUserAttributes {
fluent_builders::AdminUpdateUserAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AdminUserGlobalSignOut`](crate::client::fluent_builders::AdminUserGlobalSignOut) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::AdminUserGlobalSignOut::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::AdminUserGlobalSignOut::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::AdminUserGlobalSignOut::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::AdminUserGlobalSignOut::set_username): <p>The user name.</p>
/// - On success, responds with [`AdminUserGlobalSignOutOutput`](crate::output::AdminUserGlobalSignOutOutput)
/// - On failure, responds with [`SdkError<AdminUserGlobalSignOutError>`](crate::error::AdminUserGlobalSignOutError)
pub fn admin_user_global_sign_out(&self) -> fluent_builders::AdminUserGlobalSignOut {
fluent_builders::AdminUserGlobalSignOut::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`AssociateSoftwareToken`](crate::client::fluent_builders::AssociateSoftwareToken) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::AssociateSoftwareToken::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::AssociateSoftwareToken::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose software token you want to generate.</p>
/// - [`session(impl Into<String>)`](crate::client::fluent_builders::AssociateSoftwareToken::session) / [`set_session(Option<String>)`](crate::client::fluent_builders::AssociateSoftwareToken::set_session): <p>The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.</p>
/// - On success, responds with [`AssociateSoftwareTokenOutput`](crate::output::AssociateSoftwareTokenOutput) with field(s):
/// - [`secret_code(Option<String>)`](crate::output::AssociateSoftwareTokenOutput::secret_code): <p>A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.</p>
/// - [`session(Option<String>)`](crate::output::AssociateSoftwareTokenOutput::session): <p>The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.</p>
/// - On failure, responds with [`SdkError<AssociateSoftwareTokenError>`](crate::error::AssociateSoftwareTokenError)
pub fn associate_software_token(&self) -> fluent_builders::AssociateSoftwareToken {
fluent_builders::AssociateSoftwareToken::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ChangePassword`](crate::client::fluent_builders::ChangePassword) operation.
///
/// - The fluent builder is configurable:
/// - [`previous_password(impl Into<String>)`](crate::client::fluent_builders::ChangePassword::previous_password) / [`set_previous_password(Option<String>)`](crate::client::fluent_builders::ChangePassword::set_previous_password): <p>The old password.</p>
/// - [`proposed_password(impl Into<String>)`](crate::client::fluent_builders::ChangePassword::proposed_password) / [`set_proposed_password(Option<String>)`](crate::client::fluent_builders::ChangePassword::set_proposed_password): <p>The new password.</p>
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::ChangePassword::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::ChangePassword::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose password you want to change.</p>
/// - On success, responds with [`ChangePasswordOutput`](crate::output::ChangePasswordOutput)
/// - On failure, responds with [`SdkError<ChangePasswordError>`](crate::error::ChangePasswordError)
pub fn change_password(&self) -> fluent_builders::ChangePassword {
fluent_builders::ChangePassword::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ConfirmDevice`](crate::client::fluent_builders::ConfirmDevice) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::ConfirmDevice::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::ConfirmDevice::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose device you want to confirm.</p>
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::ConfirmDevice::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::ConfirmDevice::set_device_key): <p>The device key.</p>
/// - [`device_secret_verifier_config(DeviceSecretVerifierConfigType)`](crate::client::fluent_builders::ConfirmDevice::device_secret_verifier_config) / [`set_device_secret_verifier_config(Option<DeviceSecretVerifierConfigType>)`](crate::client::fluent_builders::ConfirmDevice::set_device_secret_verifier_config): <p>The configuration of the device secret verifier.</p>
/// - [`device_name(impl Into<String>)`](crate::client::fluent_builders::ConfirmDevice::device_name) / [`set_device_name(Option<String>)`](crate::client::fluent_builders::ConfirmDevice::set_device_name): <p>The device name.</p>
/// - On success, responds with [`ConfirmDeviceOutput`](crate::output::ConfirmDeviceOutput) with field(s):
/// - [`user_confirmation_necessary(bool)`](crate::output::ConfirmDeviceOutput::user_confirmation_necessary): <p>Indicates whether the user confirmation must confirm the device response.</p>
/// - On failure, responds with [`SdkError<ConfirmDeviceError>`](crate::error::ConfirmDeviceError)
pub fn confirm_device(&self) -> fluent_builders::ConfirmDevice {
fluent_builders::ConfirmDevice::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ConfirmForgotPassword`](crate::client::fluent_builders::ConfirmForgotPassword) operation.
///
/// - The fluent builder is configurable:
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_client_id): <p>The app client ID of the app associated with the user pool.</p>
/// - [`secret_hash(impl Into<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::secret_hash) / [`set_secret_hash(Option<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_secret_hash): <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_username): <p>The user name of the user for whom you want to enter a code to retrieve a forgotten password.</p>
/// - [`confirmation_code(impl Into<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::confirmation_code) / [`set_confirmation_code(Option<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_confirmation_code): <p>The confirmation code from your user's request to reset their password. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
/// - [`password(impl Into<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::password) / [`set_password(Option<String>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_password): <p>The new password that your user wants to set.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::ConfirmForgotPassword::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmForgotPassword</code> calls.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::ConfirmForgotPassword::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::ConfirmForgotPassword::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::ConfirmForgotPassword::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`ConfirmForgotPasswordOutput`](crate::output::ConfirmForgotPasswordOutput)
/// - On failure, responds with [`SdkError<ConfirmForgotPasswordError>`](crate::error::ConfirmForgotPasswordError)
pub fn confirm_forgot_password(&self) -> fluent_builders::ConfirmForgotPassword {
fluent_builders::ConfirmForgotPassword::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ConfirmSignUp`](crate::client::fluent_builders::ConfirmSignUp) operation.
///
/// - The fluent builder is configurable:
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::ConfirmSignUp::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::ConfirmSignUp::set_client_id): <p>The ID of the app client associated with the user pool.</p>
/// - [`secret_hash(impl Into<String>)`](crate::client::fluent_builders::ConfirmSignUp::secret_hash) / [`set_secret_hash(Option<String>)`](crate::client::fluent_builders::ConfirmSignUp::set_secret_hash): <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::ConfirmSignUp::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::ConfirmSignUp::set_username): <p>The user name of the user whose registration you want to confirm.</p>
/// - [`confirmation_code(impl Into<String>)`](crate::client::fluent_builders::ConfirmSignUp::confirmation_code) / [`set_confirmation_code(Option<String>)`](crate::client::fluent_builders::ConfirmSignUp::set_confirmation_code): <p>The confirmation code sent by a user's request to confirm registration.</p>
/// - [`force_alias_creation(bool)`](crate::client::fluent_builders::ConfirmSignUp::force_alias_creation) / [`set_force_alias_creation(bool)`](crate::client::fluent_builders::ConfirmSignUp::set_force_alias_creation): <p>Boolean to be specified to force user confirmation irrespective of existing alias. By default set to <code>False</code>. If this parameter is set to <code>True</code> and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to <code>False</code>, the API will throw an <b>AliasExistsException</b> error.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::ConfirmSignUp::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::ConfirmSignUp::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmSignUp</code> calls.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::ConfirmSignUp::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::ConfirmSignUp::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::ConfirmSignUp::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::ConfirmSignUp::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`ConfirmSignUpOutput`](crate::output::ConfirmSignUpOutput)
/// - On failure, responds with [`SdkError<ConfirmSignUpError>`](crate::error::ConfirmSignUpError)
pub fn confirm_sign_up(&self) -> fluent_builders::ConfirmSignUp {
fluent_builders::ConfirmSignUp::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateGroup`](crate::client::fluent_builders::CreateGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::CreateGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::CreateGroup::set_group_name): <p>The name of the group. Must be unique.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::CreateGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::CreateGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::CreateGroup::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::CreateGroup::set_description): <p>A string containing the description of the group.</p>
/// - [`role_arn(impl Into<String>)`](crate::client::fluent_builders::CreateGroup::role_arn) / [`set_role_arn(Option<String>)`](crate::client::fluent_builders::CreateGroup::set_role_arn): <p>The role Amazon Resource Name (ARN) for the group.</p>
/// - [`precedence(i32)`](crate::client::fluent_builders::CreateGroup::precedence) / [`set_precedence(Option<i32>)`](crate::client::fluent_builders::CreateGroup::set_precedence): <p>A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p> <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p> <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
/// - On success, responds with [`CreateGroupOutput`](crate::output::CreateGroupOutput) with field(s):
/// - [`group(Option<GroupType>)`](crate::output::CreateGroupOutput::group): <p>The group object for the group.</p>
/// - On failure, responds with [`SdkError<CreateGroupError>`](crate::error::CreateGroupError)
pub fn create_group(&self) -> fluent_builders::CreateGroup {
fluent_builders::CreateGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateIdentityProvider`](crate::client::fluent_builders::CreateIdentityProvider) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::CreateIdentityProvider::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::CreateIdentityProvider::set_user_pool_id): <p>The user pool ID.</p>
/// - [`provider_name(impl Into<String>)`](crate::client::fluent_builders::CreateIdentityProvider::provider_name) / [`set_provider_name(Option<String>)`](crate::client::fluent_builders::CreateIdentityProvider::set_provider_name): <p>The IdP name.</p>
/// - [`provider_type(IdentityProviderTypeType)`](crate::client::fluent_builders::CreateIdentityProvider::provider_type) / [`set_provider_type(Option<IdentityProviderTypeType>)`](crate::client::fluent_builders::CreateIdentityProvider::set_provider_type): <p>The IdP type.</p>
/// - [`provider_details(HashMap<String, String>)`](crate::client::fluent_builders::CreateIdentityProvider::provider_details) / [`set_provider_details(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreateIdentityProvider::set_provider_details): <p>The IdP details. The following list describes the provider detail keys for each IdP type.</p> <ul> <li> <p>For Google and Login with Amazon:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For Facebook:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>authorize_scopes</p> </li> <li> <p>api_version</p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p>client_id</p> </li> <li> <p>team_id</p> </li> <li> <p>key_id</p> </li> <li> <p>private_key</p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For OpenID Connect (OIDC) providers:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>attributes_request_method</p> </li> <li> <p>oidc_issuer</p> </li> <li> <p>authorize_scopes</p> </li> <li> <p>The following keys are only present if Amazon Cognito didn't discover them at the <code>oidc_issuer</code> URL.</p> <ul> <li> <p>authorize_url </p> </li> <li> <p>token_url </p> </li> <li> <p>attributes_url </p> </li> <li> <p>jwks_uri </p> </li> </ul> </li> <li> <p>Amazon Cognito sets the value of the following keys automatically. They are read-only.</p> <ul> <li> <p>attributes_url_add_attributes </p> </li> </ul> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p>MetadataFile or MetadataURL</p> </li> <li> <p>IDPSignout <i>optional</i> </p> </li> </ul> </li> </ul>
/// - [`attribute_mapping(HashMap<String, String>)`](crate::client::fluent_builders::CreateIdentityProvider::attribute_mapping) / [`set_attribute_mapping(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreateIdentityProvider::set_attribute_mapping): <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
/// - [`idp_identifiers(Vec<String>)`](crate::client::fluent_builders::CreateIdentityProvider::idp_identifiers) / [`set_idp_identifiers(Option<Vec<String>>)`](crate::client::fluent_builders::CreateIdentityProvider::set_idp_identifiers): <p>A list of IdP identifiers.</p>
/// - On success, responds with [`CreateIdentityProviderOutput`](crate::output::CreateIdentityProviderOutput) with field(s):
/// - [`identity_provider(Option<IdentityProviderType>)`](crate::output::CreateIdentityProviderOutput::identity_provider): <p>The newly created IdP object.</p>
/// - On failure, responds with [`SdkError<CreateIdentityProviderError>`](crate::error::CreateIdentityProviderError)
pub fn create_identity_provider(&self) -> fluent_builders::CreateIdentityProvider {
fluent_builders::CreateIdentityProvider::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateResourceServer`](crate::client::fluent_builders::CreateResourceServer) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::CreateResourceServer::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::CreateResourceServer::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`identifier(impl Into<String>)`](crate::client::fluent_builders::CreateResourceServer::identifier) / [`set_identifier(Option<String>)`](crate::client::fluent_builders::CreateResourceServer::set_identifier): <p>A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as <code>https://my-weather-api.example.com</code>.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateResourceServer::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateResourceServer::set_name): <p>A friendly name for the resource server.</p>
/// - [`scopes(Vec<ResourceServerScopeType>)`](crate::client::fluent_builders::CreateResourceServer::scopes) / [`set_scopes(Option<Vec<ResourceServerScopeType>>)`](crate::client::fluent_builders::CreateResourceServer::set_scopes): <p>A list of scopes. Each scope is a key-value map with the keys <code>name</code> and <code>description</code>.</p>
/// - On success, responds with [`CreateResourceServerOutput`](crate::output::CreateResourceServerOutput) with field(s):
/// - [`resource_server(Option<ResourceServerType>)`](crate::output::CreateResourceServerOutput::resource_server): <p>The newly created resource server.</p>
/// - On failure, responds with [`SdkError<CreateResourceServerError>`](crate::error::CreateResourceServerError)
pub fn create_resource_server(&self) -> fluent_builders::CreateResourceServer {
fluent_builders::CreateResourceServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateUserImportJob`](crate::client::fluent_builders::CreateUserImportJob) operation.
///
/// - The fluent builder is configurable:
/// - [`job_name(impl Into<String>)`](crate::client::fluent_builders::CreateUserImportJob::job_name) / [`set_job_name(Option<String>)`](crate::client::fluent_builders::CreateUserImportJob::set_job_name): <p>The job name for the user import job.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::CreateUserImportJob::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::CreateUserImportJob::set_user_pool_id): <p>The user pool ID for the user pool that the users are being imported into.</p>
/// - [`cloud_watch_logs_role_arn(impl Into<String>)`](crate::client::fluent_builders::CreateUserImportJob::cloud_watch_logs_role_arn) / [`set_cloud_watch_logs_role_arn(Option<String>)`](crate::client::fluent_builders::CreateUserImportJob::set_cloud_watch_logs_role_arn): <p>The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.</p>
/// - On success, responds with [`CreateUserImportJobOutput`](crate::output::CreateUserImportJobOutput) with field(s):
/// - [`user_import_job(Option<UserImportJobType>)`](crate::output::CreateUserImportJobOutput::user_import_job): <p>The job object that represents the user import job.</p>
/// - On failure, responds with [`SdkError<CreateUserImportJobError>`](crate::error::CreateUserImportJobError)
pub fn create_user_import_job(&self) -> fluent_builders::CreateUserImportJob {
fluent_builders::CreateUserImportJob::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateUserPool`](crate::client::fluent_builders::CreateUserPool) operation.
///
/// - The fluent builder is configurable:
/// - [`pool_name(impl Into<String>)`](crate::client::fluent_builders::CreateUserPool::pool_name) / [`set_pool_name(Option<String>)`](crate::client::fluent_builders::CreateUserPool::set_pool_name): <p>A string used to name the user pool.</p>
/// - [`policies(UserPoolPolicyType)`](crate::client::fluent_builders::CreateUserPool::policies) / [`set_policies(Option<UserPoolPolicyType>)`](crate::client::fluent_builders::CreateUserPool::set_policies): <p>The policies associated with the new user pool.</p>
/// - [`deletion_protection(DeletionProtectionType)`](crate::client::fluent_builders::CreateUserPool::deletion_protection) / [`set_deletion_protection(Option<DeletionProtectionType>)`](crate::client::fluent_builders::CreateUserPool::set_deletion_protection): <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p> <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
/// - [`lambda_config(LambdaConfigType)`](crate::client::fluent_builders::CreateUserPool::lambda_config) / [`set_lambda_config(Option<LambdaConfigType>)`](crate::client::fluent_builders::CreateUserPool::set_lambda_config): <p>The Lambda trigger configuration information for the new user pool.</p> <note> <p>In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.</p> <p></p> <p>For more information on using the Lambda API to add permission, see<a href="https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html"> AddPermission </a>. </p> <p>For adding permission using the CLI, see<a href="https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html"> add-permission </a>.</p> </note>
/// - [`auto_verified_attributes(Vec<VerifiedAttributeType>)`](crate::client::fluent_builders::CreateUserPool::auto_verified_attributes) / [`set_auto_verified_attributes(Option<Vec<VerifiedAttributeType>>)`](crate::client::fluent_builders::CreateUserPool::set_auto_verified_attributes): <p>The attributes to be auto-verified. Possible values: <b>email</b>, <b>phone_number</b>.</p>
/// - [`alias_attributes(Vec<AliasAttributeType>)`](crate::client::fluent_builders::CreateUserPool::alias_attributes) / [`set_alias_attributes(Option<Vec<AliasAttributeType>>)`](crate::client::fluent_builders::CreateUserPool::set_alias_attributes): <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or <b>preferred_username</b>.</p>
/// - [`username_attributes(Vec<UsernameAttributeType>)`](crate::client::fluent_builders::CreateUserPool::username_attributes) / [`set_username_attributes(Option<Vec<UsernameAttributeType>>)`](crate::client::fluent_builders::CreateUserPool::set_username_attributes): <p>Specifies whether a user can use an email address or phone number as a username when they sign up.</p>
/// - [`sms_verification_message(impl Into<String>)`](crate::client::fluent_builders::CreateUserPool::sms_verification_message) / [`set_sms_verification_message(Option<String>)`](crate::client::fluent_builders::CreateUserPool::set_sms_verification_message): <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
/// - [`email_verification_message(impl Into<String>)`](crate::client::fluent_builders::CreateUserPool::email_verification_message) / [`set_email_verification_message(Option<String>)`](crate::client::fluent_builders::CreateUserPool::set_email_verification_message): <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
/// - [`email_verification_subject(impl Into<String>)`](crate::client::fluent_builders::CreateUserPool::email_verification_subject) / [`set_email_verification_subject(Option<String>)`](crate::client::fluent_builders::CreateUserPool::set_email_verification_subject): <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
/// - [`verification_message_template(VerificationMessageTemplateType)`](crate::client::fluent_builders::CreateUserPool::verification_message_template) / [`set_verification_message_template(Option<VerificationMessageTemplateType>)`](crate::client::fluent_builders::CreateUserPool::set_verification_message_template): <p>The template for the verification message that the user sees when the app requests permission to access the user's information.</p>
/// - [`sms_authentication_message(impl Into<String>)`](crate::client::fluent_builders::CreateUserPool::sms_authentication_message) / [`set_sms_authentication_message(Option<String>)`](crate::client::fluent_builders::CreateUserPool::set_sms_authentication_message): <p>A string representing the SMS authentication message.</p>
/// - [`mfa_configuration(UserPoolMfaType)`](crate::client::fluent_builders::CreateUserPool::mfa_configuration) / [`set_mfa_configuration(Option<UserPoolMfaType>)`](crate::client::fluent_builders::CreateUserPool::set_mfa_configuration): <p>Specifies MFA configuration details.</p>
/// - [`user_attribute_update_settings(UserAttributeUpdateSettingsType)`](crate::client::fluent_builders::CreateUserPool::user_attribute_update_settings) / [`set_user_attribute_update_settings(Option<UserAttributeUpdateSettingsType>)`](crate::client::fluent_builders::CreateUserPool::set_user_attribute_update_settings): <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
/// - [`device_configuration(DeviceConfigurationType)`](crate::client::fluent_builders::CreateUserPool::device_configuration) / [`set_device_configuration(Option<DeviceConfigurationType>)`](crate::client::fluent_builders::CreateUserPool::set_device_configuration): <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note> <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p> </note>
/// - [`email_configuration(EmailConfigurationType)`](crate::client::fluent_builders::CreateUserPool::email_configuration) / [`set_email_configuration(Option<EmailConfigurationType>)`](crate::client::fluent_builders::CreateUserPool::set_email_configuration): <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.</p>
/// - [`sms_configuration(SmsConfigurationType)`](crate::client::fluent_builders::CreateUserPool::sms_configuration) / [`set_sms_configuration(Option<SmsConfigurationType>)`](crate::client::fluent_builders::CreateUserPool::set_sms_configuration): <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
/// - [`user_pool_tags(HashMap<String, String>)`](crate::client::fluent_builders::CreateUserPool::user_pool_tags) / [`set_user_pool_tags(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreateUserPool::set_user_pool_tags): <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
/// - [`admin_create_user_config(AdminCreateUserConfigType)`](crate::client::fluent_builders::CreateUserPool::admin_create_user_config) / [`set_admin_create_user_config(Option<AdminCreateUserConfigType>)`](crate::client::fluent_builders::CreateUserPool::set_admin_create_user_config): <p>The configuration for <code>AdminCreateUser</code> requests.</p>
/// - [`schema(Vec<SchemaAttributeType>)`](crate::client::fluent_builders::CreateUserPool::schema) / [`set_schema(Option<Vec<SchemaAttributeType>>)`](crate::client::fluent_builders::CreateUserPool::set_schema): <p>An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.</p>
/// - [`user_pool_add_ons(UserPoolAddOnsType)`](crate::client::fluent_builders::CreateUserPool::user_pool_add_ons) / [`set_user_pool_add_ons(Option<UserPoolAddOnsType>)`](crate::client::fluent_builders::CreateUserPool::set_user_pool_add_ons): <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
/// - [`username_configuration(UsernameConfigurationType)`](crate::client::fluent_builders::CreateUserPool::username_configuration) / [`set_username_configuration(Option<UsernameConfigurationType>)`](crate::client::fluent_builders::CreateUserPool::set_username_configuration): <p>Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to <code>False</code>, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
/// - [`account_recovery_setting(AccountRecoverySettingType)`](crate::client::fluent_builders::CreateUserPool::account_recovery_setting) / [`set_account_recovery_setting(Option<AccountRecoverySettingType>)`](crate::client::fluent_builders::CreateUserPool::set_account_recovery_setting): <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
/// - On success, responds with [`CreateUserPoolOutput`](crate::output::CreateUserPoolOutput) with field(s):
/// - [`user_pool(Option<UserPoolType>)`](crate::output::CreateUserPoolOutput::user_pool): <p>A container for the user pool details.</p>
/// - On failure, responds with [`SdkError<CreateUserPoolError>`](crate::error::CreateUserPoolError)
pub fn create_user_pool(&self) -> fluent_builders::CreateUserPool {
fluent_builders::CreateUserPool::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateUserPoolClient`](crate::client::fluent_builders::CreateUserPoolClient) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::CreateUserPoolClient::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::CreateUserPoolClient::set_user_pool_id): <p>The user pool ID for the user pool where you want to create a user pool client.</p>
/// - [`client_name(impl Into<String>)`](crate::client::fluent_builders::CreateUserPoolClient::client_name) / [`set_client_name(Option<String>)`](crate::client::fluent_builders::CreateUserPoolClient::set_client_name): <p>The client name for the user pool client you would like to create.</p>
/// - [`generate_secret(bool)`](crate::client::fluent_builders::CreateUserPoolClient::generate_secret) / [`set_generate_secret(bool)`](crate::client::fluent_builders::CreateUserPoolClient::set_generate_secret): <p>Boolean to specify whether you want to generate a secret for the user pool client being created.</p>
/// - [`refresh_token_validity(i32)`](crate::client::fluent_builders::CreateUserPoolClient::refresh_token_validity) / [`set_refresh_token_validity(i32)`](crate::client::fluent_builders::CreateUserPoolClient::set_refresh_token_validity): <p>The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p> <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session and retrieve new access and ID tokens for 10 days.</p> <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days. You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. <i>Valid range</i> is displayed below in seconds.</p> <p>If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.</p>
/// - [`access_token_validity(i32)`](crate::client::fluent_builders::CreateUserPoolClient::access_token_validity) / [`set_access_token_validity(Option<i32>)`](crate::client::fluent_builders::CreateUserPoolClient::set_access_token_validity): <p>The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for <code>AccessTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p> <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with their access token for 10 hours.</p> <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p> <p>If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.</p>
/// - [`id_token_validity(i32)`](crate::client::fluent_builders::CreateUserPoolClient::id_token_validity) / [`set_id_token_validity(Option<i32>)`](crate::client::fluent_builders::CreateUserPoolClient::set_id_token_validity): <p>The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for <code>IdTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p> <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their session with their ID token for 10 hours.</p> <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p> <p>If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.</p>
/// - [`token_validity_units(TokenValidityUnitsType)`](crate::client::fluent_builders::CreateUserPoolClient::token_validity_units) / [`set_token_validity_units(Option<TokenValidityUnitsType>)`](crate::client::fluent_builders::CreateUserPoolClient::set_token_validity_units): <p>The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.</p>
/// - [`read_attributes(Vec<String>)`](crate::client::fluent_builders::CreateUserPoolClient::read_attributes) / [`set_read_attributes(Option<Vec<String>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_read_attributes): <p>The read attributes.</p>
/// - [`write_attributes(Vec<String>)`](crate::client::fluent_builders::CreateUserPoolClient::write_attributes) / [`set_write_attributes(Option<Vec<String>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_write_attributes): <p>The user pool attributes that the app client can write to.</p> <p>If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user pool</a>.</p>
/// - [`explicit_auth_flows(Vec<ExplicitAuthFlowsType>)`](crate::client::fluent_builders::CreateUserPoolClient::explicit_auth_flows) / [`set_explicit_auth_flows(Option<Vec<ExplicitAuthFlowsType>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_explicit_auth_flows): <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.</p> <note> <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p> </note> <p>Valid values include:</p> <ul> <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.</p> </li> <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li> <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li> <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li> <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li> </ul> <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>. You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>, like <code>ALLOW_USER_SRP_AUTH</code>.</p>
/// - [`supported_identity_providers(Vec<String>)`](crate::client::fluent_builders::CreateUserPoolClient::supported_identity_providers) / [`set_supported_identity_providers(Option<Vec<String>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_supported_identity_providers): <p>A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
/// - [`callback_ur_ls(Vec<String>)`](crate::client::fluent_builders::CreateUserPoolClient::callback_ur_ls) / [`set_callback_ur_ls(Option<Vec<String>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_callback_ur_ls): <p>A list of allowed redirect (callback) URLs for the IdPs.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p> <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p> <p>App callback URLs such as myapp://example are also supported.</p>
/// - [`logout_ur_ls(Vec<String>)`](crate::client::fluent_builders::CreateUserPoolClient::logout_ur_ls) / [`set_logout_ur_ls(Option<Vec<String>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_logout_ur_ls): <p>A list of allowed logout URLs for the IdPs.</p>
/// - [`default_redirect_uri(impl Into<String>)`](crate::client::fluent_builders::CreateUserPoolClient::default_redirect_uri) / [`set_default_redirect_uri(Option<String>)`](crate::client::fluent_builders::CreateUserPoolClient::set_default_redirect_uri): <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p> <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p> <p>App callback URLs such as myapp://example are also supported.</p>
/// - [`allowed_o_auth_flows(Vec<OAuthFlowType>)`](crate::client::fluent_builders::CreateUserPoolClient::allowed_o_auth_flows) / [`set_allowed_o_auth_flows(Option<Vec<OAuthFlowType>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_allowed_o_auth_flows): <p>The allowed OAuth flows.</p> <dl> <dt> code </dt> <dd> <p>Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the <code>/oauth2/token</code> endpoint.</p> </dd> <dt> implicit </dt> <dd> <p>Issue the access token (and, optionally, ID token, based on scopes) directly to your user.</p> </dd> <dt> client_credentials </dt> <dd> <p>Issue the access token from the <code>/oauth2/token</code> endpoint directly to a non-person user using a combination of the client ID and client secret.</p> </dd> </dl>
/// - [`allowed_o_auth_scopes(Vec<String>)`](crate::client::fluent_builders::CreateUserPoolClient::allowed_o_auth_scopes) / [`set_allowed_o_auth_scopes(Option<Vec<String>>)`](crate::client::fluent_builders::CreateUserPoolClient::set_allowed_o_auth_scopes): <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>
/// - [`allowed_o_auth_flows_user_pool_client(bool)`](crate::client::fluent_builders::CreateUserPoolClient::allowed_o_auth_flows_user_pool_client) / [`set_allowed_o_auth_flows_user_pool_client(bool)`](crate::client::fluent_builders::CreateUserPoolClient::set_allowed_o_auth_flows_user_pool_client): <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
/// - [`analytics_configuration(AnalyticsConfigurationType)`](crate::client::fluent_builders::CreateUserPoolClient::analytics_configuration) / [`set_analytics_configuration(Option<AnalyticsConfigurationType>)`](crate::client::fluent_builders::CreateUserPoolClient::set_analytics_configuration): <p>The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.</p> <note> <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p> </note>
/// - [`prevent_user_existence_errors(PreventUserExistenceErrorTypes)`](crate::client::fluent_builders::CreateUserPoolClient::prevent_user_existence_errors) / [`set_prevent_user_existence_errors(Option<PreventUserExistenceErrorTypes>)`](crate::client::fluent_builders::CreateUserPoolClient::set_prevent_user_existence_errors): <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.</p> </li> </ul>
/// - [`enable_token_revocation(bool)`](crate::client::fluent_builders::CreateUserPoolClient::enable_token_revocation) / [`set_enable_token_revocation(Option<bool>)`](crate::client::fluent_builders::CreateUserPoolClient::set_enable_token_revocation): <p>Activates or deactivates token revocation. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p> <p>If you don't include this parameter, token revocation is automatically activated for the new user pool client.</p>
/// - [`enable_propagate_additional_user_context_data(bool)`](crate::client::fluent_builders::CreateUserPoolClient::enable_propagate_additional_user_context_data) / [`set_enable_propagate_additional_user_context_data(Option<bool>)`](crate::client::fluent_builders::CreateUserPoolClient::set_enable_propagate_additional_user_context_data): <p>Activates the propagation of additional user context data. For more information about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a client secret.</p>
/// - [`auth_session_validity(i32)`](crate::client::fluent_builders::CreateUserPoolClient::auth_session_validity) / [`set_auth_session_validity(Option<i32>)`](crate::client::fluent_builders::CreateUserPoolClient::set_auth_session_validity): <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
/// - On success, responds with [`CreateUserPoolClientOutput`](crate::output::CreateUserPoolClientOutput) with field(s):
/// - [`user_pool_client(Option<UserPoolClientType>)`](crate::output::CreateUserPoolClientOutput::user_pool_client): <p>The user pool client that was just created.</p>
/// - On failure, responds with [`SdkError<CreateUserPoolClientError>`](crate::error::CreateUserPoolClientError)
pub fn create_user_pool_client(&self) -> fluent_builders::CreateUserPoolClient {
fluent_builders::CreateUserPoolClient::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateUserPoolDomain`](crate::client::fluent_builders::CreateUserPoolDomain) operation.
///
/// - The fluent builder is configurable:
/// - [`domain(impl Into<String>)`](crate::client::fluent_builders::CreateUserPoolDomain::domain) / [`set_domain(Option<String>)`](crate::client::fluent_builders::CreateUserPoolDomain::set_domain): <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::CreateUserPoolDomain::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::CreateUserPoolDomain::set_user_pool_id): <p>The user pool ID.</p>
/// - [`custom_domain_config(CustomDomainConfigType)`](crate::client::fluent_builders::CreateUserPoolDomain::custom_domain_config) / [`set_custom_domain_config(Option<CustomDomainConfigType>)`](crate::client::fluent_builders::CreateUserPoolDomain::set_custom_domain_config): <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p> <p>Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.</p> <p>For more information about the hosted domain and custom domains, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html">Configuring a User Pool Domain</a>.</p>
/// - On success, responds with [`CreateUserPoolDomainOutput`](crate::output::CreateUserPoolDomainOutput) with field(s):
/// - [`cloud_front_domain(Option<String>)`](crate::output::CreateUserPoolDomainOutput::cloud_front_domain): <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.</p>
/// - On failure, responds with [`SdkError<CreateUserPoolDomainError>`](crate::error::CreateUserPoolDomainError)
pub fn create_user_pool_domain(&self) -> fluent_builders::CreateUserPoolDomain {
fluent_builders::CreateUserPoolDomain::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteGroup`](crate::client::fluent_builders::DeleteGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::DeleteGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::DeleteGroup::set_group_name): <p>The name of the group.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DeleteGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DeleteGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - On success, responds with [`DeleteGroupOutput`](crate::output::DeleteGroupOutput)
/// - On failure, responds with [`SdkError<DeleteGroupError>`](crate::error::DeleteGroupError)
pub fn delete_group(&self) -> fluent_builders::DeleteGroup {
fluent_builders::DeleteGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteIdentityProvider`](crate::client::fluent_builders::DeleteIdentityProvider) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DeleteIdentityProvider::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DeleteIdentityProvider::set_user_pool_id): <p>The user pool ID.</p>
/// - [`provider_name(impl Into<String>)`](crate::client::fluent_builders::DeleteIdentityProvider::provider_name) / [`set_provider_name(Option<String>)`](crate::client::fluent_builders::DeleteIdentityProvider::set_provider_name): <p>The IdP name.</p>
/// - On success, responds with [`DeleteIdentityProviderOutput`](crate::output::DeleteIdentityProviderOutput)
/// - On failure, responds with [`SdkError<DeleteIdentityProviderError>`](crate::error::DeleteIdentityProviderError)
pub fn delete_identity_provider(&self) -> fluent_builders::DeleteIdentityProvider {
fluent_builders::DeleteIdentityProvider::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteResourceServer`](crate::client::fluent_builders::DeleteResourceServer) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DeleteResourceServer::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DeleteResourceServer::set_user_pool_id): <p>The user pool ID for the user pool that hosts the resource server.</p>
/// - [`identifier(impl Into<String>)`](crate::client::fluent_builders::DeleteResourceServer::identifier) / [`set_identifier(Option<String>)`](crate::client::fluent_builders::DeleteResourceServer::set_identifier): <p>The identifier for the resource server.</p>
/// - On success, responds with [`DeleteResourceServerOutput`](crate::output::DeleteResourceServerOutput)
/// - On failure, responds with [`SdkError<DeleteResourceServerError>`](crate::error::DeleteResourceServerError)
pub fn delete_resource_server(&self) -> fluent_builders::DeleteResourceServer {
fluent_builders::DeleteResourceServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteUser`](crate::client::fluent_builders::DeleteUser) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::DeleteUser::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::DeleteUser::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.</p>
/// - On success, responds with [`DeleteUserOutput`](crate::output::DeleteUserOutput)
/// - On failure, responds with [`SdkError<DeleteUserError>`](crate::error::DeleteUserError)
pub fn delete_user(&self) -> fluent_builders::DeleteUser {
fluent_builders::DeleteUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteUserAttributes`](crate::client::fluent_builders::DeleteUserAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`user_attribute_names(Vec<String>)`](crate::client::fluent_builders::DeleteUserAttributes::user_attribute_names) / [`set_user_attribute_names(Option<Vec<String>>)`](crate::client::fluent_builders::DeleteUserAttributes::set_user_attribute_names): <p>An array of strings representing the user attribute names you want to delete.</p> <p>For custom attributes, you must prependattach the <code>custom:</code> prefix to the front of the attribute name.</p>
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::DeleteUserAttributes::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::DeleteUserAttributes::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.</p>
/// - On success, responds with [`DeleteUserAttributesOutput`](crate::output::DeleteUserAttributesOutput)
/// - On failure, responds with [`SdkError<DeleteUserAttributesError>`](crate::error::DeleteUserAttributesError)
pub fn delete_user_attributes(&self) -> fluent_builders::DeleteUserAttributes {
fluent_builders::DeleteUserAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteUserPool`](crate::client::fluent_builders::DeleteUserPool) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DeleteUserPool::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DeleteUserPool::set_user_pool_id): <p>The user pool ID for the user pool you want to delete.</p>
/// - On success, responds with [`DeleteUserPoolOutput`](crate::output::DeleteUserPoolOutput)
/// - On failure, responds with [`SdkError<DeleteUserPoolError>`](crate::error::DeleteUserPoolError)
pub fn delete_user_pool(&self) -> fluent_builders::DeleteUserPool {
fluent_builders::DeleteUserPool::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteUserPoolClient`](crate::client::fluent_builders::DeleteUserPoolClient) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DeleteUserPoolClient::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DeleteUserPoolClient::set_user_pool_id): <p>The user pool ID for the user pool where you want to delete the client.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::DeleteUserPoolClient::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::DeleteUserPoolClient::set_client_id): <p>The app client ID of the app associated with the user pool.</p>
/// - On success, responds with [`DeleteUserPoolClientOutput`](crate::output::DeleteUserPoolClientOutput)
/// - On failure, responds with [`SdkError<DeleteUserPoolClientError>`](crate::error::DeleteUserPoolClientError)
pub fn delete_user_pool_client(&self) -> fluent_builders::DeleteUserPoolClient {
fluent_builders::DeleteUserPoolClient::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteUserPoolDomain`](crate::client::fluent_builders::DeleteUserPoolDomain) operation.
///
/// - The fluent builder is configurable:
/// - [`domain(impl Into<String>)`](crate::client::fluent_builders::DeleteUserPoolDomain::domain) / [`set_domain(Option<String>)`](crate::client::fluent_builders::DeleteUserPoolDomain::set_domain): <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DeleteUserPoolDomain::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DeleteUserPoolDomain::set_user_pool_id): <p>The user pool ID.</p>
/// - On success, responds with [`DeleteUserPoolDomainOutput`](crate::output::DeleteUserPoolDomainOutput)
/// - On failure, responds with [`SdkError<DeleteUserPoolDomainError>`](crate::error::DeleteUserPoolDomainError)
pub fn delete_user_pool_domain(&self) -> fluent_builders::DeleteUserPoolDomain {
fluent_builders::DeleteUserPoolDomain::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeIdentityProvider`](crate::client::fluent_builders::DescribeIdentityProvider) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DescribeIdentityProvider::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DescribeIdentityProvider::set_user_pool_id): <p>The user pool ID.</p>
/// - [`provider_name(impl Into<String>)`](crate::client::fluent_builders::DescribeIdentityProvider::provider_name) / [`set_provider_name(Option<String>)`](crate::client::fluent_builders::DescribeIdentityProvider::set_provider_name): <p>The IdP name.</p>
/// - On success, responds with [`DescribeIdentityProviderOutput`](crate::output::DescribeIdentityProviderOutput) with field(s):
/// - [`identity_provider(Option<IdentityProviderType>)`](crate::output::DescribeIdentityProviderOutput::identity_provider): <p>The identity provider details.</p>
/// - On failure, responds with [`SdkError<DescribeIdentityProviderError>`](crate::error::DescribeIdentityProviderError)
pub fn describe_identity_provider(&self) -> fluent_builders::DescribeIdentityProvider {
fluent_builders::DescribeIdentityProvider::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeResourceServer`](crate::client::fluent_builders::DescribeResourceServer) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DescribeResourceServer::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DescribeResourceServer::set_user_pool_id): <p>The user pool ID for the user pool that hosts the resource server.</p>
/// - [`identifier(impl Into<String>)`](crate::client::fluent_builders::DescribeResourceServer::identifier) / [`set_identifier(Option<String>)`](crate::client::fluent_builders::DescribeResourceServer::set_identifier): <p>The identifier for the resource server</p>
/// - On success, responds with [`DescribeResourceServerOutput`](crate::output::DescribeResourceServerOutput) with field(s):
/// - [`resource_server(Option<ResourceServerType>)`](crate::output::DescribeResourceServerOutput::resource_server): <p>The resource server.</p>
/// - On failure, responds with [`SdkError<DescribeResourceServerError>`](crate::error::DescribeResourceServerError)
pub fn describe_resource_server(&self) -> fluent_builders::DescribeResourceServer {
fluent_builders::DescribeResourceServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeRiskConfiguration`](crate::client::fluent_builders::DescribeRiskConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DescribeRiskConfiguration::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DescribeRiskConfiguration::set_user_pool_id): <p>The user pool ID.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::DescribeRiskConfiguration::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::DescribeRiskConfiguration::set_client_id): <p>The app client ID.</p>
/// - On success, responds with [`DescribeRiskConfigurationOutput`](crate::output::DescribeRiskConfigurationOutput) with field(s):
/// - [`risk_configuration(Option<RiskConfigurationType>)`](crate::output::DescribeRiskConfigurationOutput::risk_configuration): <p>The risk configuration.</p>
/// - On failure, responds with [`SdkError<DescribeRiskConfigurationError>`](crate::error::DescribeRiskConfigurationError)
pub fn describe_risk_configuration(&self) -> fluent_builders::DescribeRiskConfiguration {
fluent_builders::DescribeRiskConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeUserImportJob`](crate::client::fluent_builders::DescribeUserImportJob) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DescribeUserImportJob::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DescribeUserImportJob::set_user_pool_id): <p>The user pool ID for the user pool that the users are being imported into.</p>
/// - [`job_id(impl Into<String>)`](crate::client::fluent_builders::DescribeUserImportJob::job_id) / [`set_job_id(Option<String>)`](crate::client::fluent_builders::DescribeUserImportJob::set_job_id): <p>The job ID for the user import job.</p>
/// - On success, responds with [`DescribeUserImportJobOutput`](crate::output::DescribeUserImportJobOutput) with field(s):
/// - [`user_import_job(Option<UserImportJobType>)`](crate::output::DescribeUserImportJobOutput::user_import_job): <p>The job object that represents the user import job.</p>
/// - On failure, responds with [`SdkError<DescribeUserImportJobError>`](crate::error::DescribeUserImportJobError)
pub fn describe_user_import_job(&self) -> fluent_builders::DescribeUserImportJob {
fluent_builders::DescribeUserImportJob::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeUserPool`](crate::client::fluent_builders::DescribeUserPool) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DescribeUserPool::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DescribeUserPool::set_user_pool_id): <p>The user pool ID for the user pool you want to describe.</p>
/// - On success, responds with [`DescribeUserPoolOutput`](crate::output::DescribeUserPoolOutput) with field(s):
/// - [`user_pool(Option<UserPoolType>)`](crate::output::DescribeUserPoolOutput::user_pool): <p>The container of metadata returned by the server to describe the pool.</p>
/// - On failure, responds with [`SdkError<DescribeUserPoolError>`](crate::error::DescribeUserPoolError)
pub fn describe_user_pool(&self) -> fluent_builders::DescribeUserPool {
fluent_builders::DescribeUserPool::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeUserPoolClient`](crate::client::fluent_builders::DescribeUserPoolClient) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::DescribeUserPoolClient::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::DescribeUserPoolClient::set_user_pool_id): <p>The user pool ID for the user pool you want to describe.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::DescribeUserPoolClient::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::DescribeUserPoolClient::set_client_id): <p>The app client ID of the app associated with the user pool.</p>
/// - On success, responds with [`DescribeUserPoolClientOutput`](crate::output::DescribeUserPoolClientOutput) with field(s):
/// - [`user_pool_client(Option<UserPoolClientType>)`](crate::output::DescribeUserPoolClientOutput::user_pool_client): <p>The user pool client from a server response to describe the user pool client.</p>
/// - On failure, responds with [`SdkError<DescribeUserPoolClientError>`](crate::error::DescribeUserPoolClientError)
pub fn describe_user_pool_client(&self) -> fluent_builders::DescribeUserPoolClient {
fluent_builders::DescribeUserPoolClient::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeUserPoolDomain`](crate::client::fluent_builders::DescribeUserPoolDomain) operation.
///
/// - The fluent builder is configurable:
/// - [`domain(impl Into<String>)`](crate::client::fluent_builders::DescribeUserPoolDomain::domain) / [`set_domain(Option<String>)`](crate::client::fluent_builders::DescribeUserPoolDomain::set_domain): <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
/// - On success, responds with [`DescribeUserPoolDomainOutput`](crate::output::DescribeUserPoolDomainOutput) with field(s):
/// - [`domain_description(Option<DomainDescriptionType>)`](crate::output::DescribeUserPoolDomainOutput::domain_description): <p>A domain description object containing information about the domain.</p>
/// - On failure, responds with [`SdkError<DescribeUserPoolDomainError>`](crate::error::DescribeUserPoolDomainError)
pub fn describe_user_pool_domain(&self) -> fluent_builders::DescribeUserPoolDomain {
fluent_builders::DescribeUserPoolDomain::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ForgetDevice`](crate::client::fluent_builders::ForgetDevice) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::ForgetDevice::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::ForgetDevice::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.</p>
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::ForgetDevice::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::ForgetDevice::set_device_key): <p>The device key.</p>
/// - On success, responds with [`ForgetDeviceOutput`](crate::output::ForgetDeviceOutput)
/// - On failure, responds with [`SdkError<ForgetDeviceError>`](crate::error::ForgetDeviceError)
pub fn forget_device(&self) -> fluent_builders::ForgetDevice {
fluent_builders::ForgetDevice::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ForgotPassword`](crate::client::fluent_builders::ForgotPassword) operation.
///
/// - The fluent builder is configurable:
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::ForgotPassword::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::ForgotPassword::set_client_id): <p>The ID of the client associated with the user pool.</p>
/// - [`secret_hash(impl Into<String>)`](crate::client::fluent_builders::ForgotPassword::secret_hash) / [`set_secret_hash(Option<String>)`](crate::client::fluent_builders::ForgotPassword::set_secret_hash): <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::ForgotPassword::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::ForgotPassword::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::ForgotPassword::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::ForgotPassword::set_username): <p>The user name of the user for whom you want to enter a code to reset a forgotten password.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::ForgotPassword::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::ForgotPassword::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>ForgotPassword</code> calls.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::ForgotPassword::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::ForgotPassword::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>user migration</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`ForgotPasswordOutput`](crate::output::ForgotPasswordOutput) with field(s):
/// - [`code_delivery_details(Option<CodeDeliveryDetailsType>)`](crate::output::ForgotPasswordOutput::code_delivery_details): <p>The code delivery details returned by the server in response to the request to reset a password.</p>
/// - On failure, responds with [`SdkError<ForgotPasswordError>`](crate::error::ForgotPasswordError)
pub fn forgot_password(&self) -> fluent_builders::ForgotPassword {
fluent_builders::ForgotPassword::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetCSVHeader`](crate::client::fluent_builders::GetCSVHeader) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::GetCSVHeader::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::GetCSVHeader::set_user_pool_id): <p>The user pool ID for the user pool that the users are to be imported into.</p>
/// - On success, responds with [`GetCsvHeaderOutput`](crate::output::GetCsvHeaderOutput) with field(s):
/// - [`user_pool_id(Option<String>)`](crate::output::GetCsvHeaderOutput::user_pool_id): <p>The user pool ID for the user pool that the users are to be imported into.</p>
/// - [`csv_header(Option<Vec<String>>)`](crate::output::GetCsvHeaderOutput::csv_header): <p>The header information of the CSV file for the user import job.</p>
/// - On failure, responds with [`SdkError<GetCSVHeaderError>`](crate::error::GetCSVHeaderError)
pub fn get_csv_header(&self) -> fluent_builders::GetCSVHeader {
fluent_builders::GetCSVHeader::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetDevice`](crate::client::fluent_builders::GetDevice) operation.
///
/// - The fluent builder is configurable:
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::GetDevice::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::GetDevice::set_device_key): <p>The device key.</p>
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::GetDevice::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::GetDevice::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose device information you want to request.</p>
/// - On success, responds with [`GetDeviceOutput`](crate::output::GetDeviceOutput) with field(s):
/// - [`device(Option<DeviceType>)`](crate::output::GetDeviceOutput::device): <p>The device.</p>
/// - On failure, responds with [`SdkError<GetDeviceError>`](crate::error::GetDeviceError)
pub fn get_device(&self) -> fluent_builders::GetDevice {
fluent_builders::GetDevice::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetGroup`](crate::client::fluent_builders::GetGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::GetGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::GetGroup::set_group_name): <p>The name of the group.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::GetGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::GetGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - On success, responds with [`GetGroupOutput`](crate::output::GetGroupOutput) with field(s):
/// - [`group(Option<GroupType>)`](crate::output::GetGroupOutput::group): <p>The group object for the group.</p>
/// - On failure, responds with [`SdkError<GetGroupError>`](crate::error::GetGroupError)
pub fn get_group(&self) -> fluent_builders::GetGroup {
fluent_builders::GetGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetIdentityProviderByIdentifier`](crate::client::fluent_builders::GetIdentityProviderByIdentifier) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::GetIdentityProviderByIdentifier::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::GetIdentityProviderByIdentifier::set_user_pool_id): <p>The user pool ID.</p>
/// - [`idp_identifier(impl Into<String>)`](crate::client::fluent_builders::GetIdentityProviderByIdentifier::idp_identifier) / [`set_idp_identifier(Option<String>)`](crate::client::fluent_builders::GetIdentityProviderByIdentifier::set_idp_identifier): <p>The IdP identifier.</p>
/// - On success, responds with [`GetIdentityProviderByIdentifierOutput`](crate::output::GetIdentityProviderByIdentifierOutput) with field(s):
/// - [`identity_provider(Option<IdentityProviderType>)`](crate::output::GetIdentityProviderByIdentifierOutput::identity_provider): <p>The identity provider details.</p>
/// - On failure, responds with [`SdkError<GetIdentityProviderByIdentifierError>`](crate::error::GetIdentityProviderByIdentifierError)
pub fn get_identity_provider_by_identifier(
&self,
) -> fluent_builders::GetIdentityProviderByIdentifier {
fluent_builders::GetIdentityProviderByIdentifier::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetSigningCertificate`](crate::client::fluent_builders::GetSigningCertificate) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::GetSigningCertificate::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::GetSigningCertificate::set_user_pool_id): <p>The user pool ID.</p>
/// - On success, responds with [`GetSigningCertificateOutput`](crate::output::GetSigningCertificateOutput) with field(s):
/// - [`certificate(Option<String>)`](crate::output::GetSigningCertificateOutput::certificate): <p>The signing certificate.</p>
/// - On failure, responds with [`SdkError<GetSigningCertificateError>`](crate::error::GetSigningCertificateError)
pub fn get_signing_certificate(&self) -> fluent_builders::GetSigningCertificate {
fluent_builders::GetSigningCertificate::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetUICustomization`](crate::client::fluent_builders::GetUICustomization) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::GetUICustomization::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::GetUICustomization::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::GetUICustomization::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::GetUICustomization::set_client_id): <p>The client ID for the client app.</p>
/// - On success, responds with [`GetUiCustomizationOutput`](crate::output::GetUiCustomizationOutput) with field(s):
/// - [`ui_customization(Option<UiCustomizationType>)`](crate::output::GetUiCustomizationOutput::ui_customization): <p>The UI customization information.</p>
/// - On failure, responds with [`SdkError<GetUICustomizationError>`](crate::error::GetUICustomizationError)
pub fn get_ui_customization(&self) -> fluent_builders::GetUICustomization {
fluent_builders::GetUICustomization::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetUser`](crate::client::fluent_builders::GetUser) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::GetUser::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::GetUser::set_access_token): <p>A non-expired access token for the user whose information you want to query.</p>
/// - On success, responds with [`GetUserOutput`](crate::output::GetUserOutput) with field(s):
/// - [`username(Option<String>)`](crate::output::GetUserOutput::username): <p>The user name of the user you want to retrieve from the get user request.</p>
/// - [`user_attributes(Option<Vec<AttributeType>>)`](crate::output::GetUserOutput::user_attributes): <p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// - [`mfa_options(Option<Vec<MfaOptionType>>)`](crate::output::GetUserOutput::mfa_options): <p> <i>This response parameter is no longer supported.</i> It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.</p>
/// - [`preferred_mfa_setting(Option<String>)`](crate::output::GetUserOutput::preferred_mfa_setting): <p>The user's preferred MFA setting.</p>
/// - [`user_mfa_setting_list(Option<Vec<String>>)`](crate::output::GetUserOutput::user_mfa_setting_list): <p>The MFA options that are activated for the user. The possible values in this list are <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
/// - On failure, responds with [`SdkError<GetUserError>`](crate::error::GetUserError)
pub fn get_user(&self) -> fluent_builders::GetUser {
fluent_builders::GetUser::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetUserAttributeVerificationCode`](crate::client::fluent_builders::GetUserAttributeVerificationCode) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::GetUserAttributeVerificationCode::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::GetUserAttributeVerificationCode::set_access_token): <p>A non-expired access token for the user whose attribute verification code you want to generate.</p>
/// - [`attribute_name(impl Into<String>)`](crate::client::fluent_builders::GetUserAttributeVerificationCode::attribute_name) / [`set_attribute_name(Option<String>)`](crate::client::fluent_builders::GetUserAttributeVerificationCode::set_attribute_name): <p>The attribute name returned by the server response to get the user attribute verification code.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::GetUserAttributeVerificationCode::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::GetUserAttributeVerificationCode::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`GetUserAttributeVerificationCodeOutput`](crate::output::GetUserAttributeVerificationCodeOutput) with field(s):
/// - [`code_delivery_details(Option<CodeDeliveryDetailsType>)`](crate::output::GetUserAttributeVerificationCodeOutput::code_delivery_details): <p>The code delivery details returned by the server in response to the request to get the user attribute verification code.</p>
/// - On failure, responds with [`SdkError<GetUserAttributeVerificationCodeError>`](crate::error::GetUserAttributeVerificationCodeError)
pub fn get_user_attribute_verification_code(
&self,
) -> fluent_builders::GetUserAttributeVerificationCode {
fluent_builders::GetUserAttributeVerificationCode::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetUserPoolMfaConfig`](crate::client::fluent_builders::GetUserPoolMfaConfig) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::GetUserPoolMfaConfig::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::GetUserPoolMfaConfig::set_user_pool_id): <p>The user pool ID.</p>
/// - On success, responds with [`GetUserPoolMfaConfigOutput`](crate::output::GetUserPoolMfaConfigOutput) with field(s):
/// - [`sms_mfa_configuration(Option<SmsMfaConfigType>)`](crate::output::GetUserPoolMfaConfigOutput::sms_mfa_configuration): <p>The SMS text message multi-factor authentication (MFA) configuration.</p>
/// - [`software_token_mfa_configuration(Option<SoftwareTokenMfaConfigType>)`](crate::output::GetUserPoolMfaConfigOutput::software_token_mfa_configuration): <p>The software token multi-factor authentication (MFA) configuration.</p>
/// - [`mfa_configuration(Option<UserPoolMfaType>)`](crate::output::GetUserPoolMfaConfigOutput::mfa_configuration): <p>The multi-factor authentication (MFA) configuration. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li> </ul>
/// - On failure, responds with [`SdkError<GetUserPoolMfaConfigError>`](crate::error::GetUserPoolMfaConfigError)
pub fn get_user_pool_mfa_config(&self) -> fluent_builders::GetUserPoolMfaConfig {
fluent_builders::GetUserPoolMfaConfig::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GlobalSignOut`](crate::client::fluent_builders::GlobalSignOut) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::GlobalSignOut::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::GlobalSignOut::set_access_token): <p>A valid access token that Amazon Cognito issued to the user who you want to sign out.</p>
/// - On success, responds with [`GlobalSignOutOutput`](crate::output::GlobalSignOutOutput)
/// - On failure, responds with [`SdkError<GlobalSignOutError>`](crate::error::GlobalSignOutError)
pub fn global_sign_out(&self) -> fluent_builders::GlobalSignOut {
fluent_builders::GlobalSignOut::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`InitiateAuth`](crate::client::fluent_builders::InitiateAuth) operation.
///
/// - The fluent builder is configurable:
/// - [`auth_flow(AuthFlowType)`](crate::client::fluent_builders::InitiateAuth::auth_flow) / [`set_auth_flow(Option<AuthFlowType>)`](crate::client::fluent_builders::InitiateAuth::set_auth_flow): <p>The authentication flow for this call to run. The API action will depend on this value. For example:</p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code> takes in a valid refresh token and returns new tokens.</p> </li> <li> <p> <code>USER_SRP_AUTH</code> takes in <code>USERNAME</code> and <code>SRP_A</code> and returns the SRP variables to be used for next challenge execution.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code> takes in <code>USERNAME</code> and <code>PASSWORD</code> and returns the next challenge or tokens.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li> <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li> <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool. </p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
/// - [`auth_parameters(HashMap<String, String>)`](crate::client::fluent_builders::InitiateAuth::auth_parameters) / [`set_auth_parameters(Option<HashMap<String, String>>)`](crate::client::fluent_builders::InitiateAuth::set_auth_parameters): <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you're invoking. The required values depend on the value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li> <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code>. To start the authentication flow with password verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The SRP_A Value)</code>.</p> </li> </ul>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::InitiateAuth::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::InitiateAuth::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p> <ul> <li> <p>Pre signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p> </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::InitiateAuth::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::InitiateAuth::set_client_id): <p>The app client ID.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::InitiateAuth::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::InitiateAuth::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>InitiateAuth</code> calls.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::InitiateAuth::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::InitiateAuth::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - On success, responds with [`InitiateAuthOutput`](crate::output::InitiateAuthOutput) with field(s):
/// - [`challenge_name(Option<ChallengeNameType>)`](crate::output::InitiateAuthOutput::challenge_name): <p>The name of the challenge that you're responding to with this call. This name is returned in the <code>AdminInitiateAuth</code> response if you must pass another challenge.</p> <p>Valid values include the following:</p> <note> <p>All of the following challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable) in the parameters.</p> </note> <ul> <li> <p> <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p> </li> <li> <p> <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code>: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their passwords after successful first login. </p> <p>Respond to this challenge with <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in the <code>requiredAttributes</code> parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>.</p> <note> <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p> </note> </li> <li> <p> <code>MFA_SETUP</code>: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters <code>MFA_CAN_SETUP</code> value. </p> <p> To set up software token MFA, use the session returned here from <code>InitiateAuth</code> as an input to <code>AssociateSoftwareToken</code>. Use the session returned by <code>VerifySoftwareToken</code> as an input to <code>RespondToAuthChallenge</code> with challenge name <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call <code>InitiateAuth</code> again to restart sign-in.</p> </li> </ul>
/// - [`session(Option<String>)`](crate::output::InitiateAuthOutput::session): <p>The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
/// - [`challenge_parameters(Option<HashMap<String, String>>)`](crate::output::InitiateAuthOutput::challenge_parameters): <p>The challenge parameters. These are returned in the <code>InitiateAuth</code> response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p> <p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable).</p>
/// - [`authentication_result(Option<AuthenticationResultType>)`](crate::output::InitiateAuthOutput::authentication_result): <p>The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
/// - On failure, responds with [`SdkError<InitiateAuthError>`](crate::error::InitiateAuthError)
pub fn initiate_auth(&self) -> fluent_builders::InitiateAuth {
fluent_builders::InitiateAuth::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListDevices`](crate::client::fluent_builders::ListDevices) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::ListDevices::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::ListDevices::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListDevices::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListDevices::set_limit): <p>The limit of the device request.</p>
/// - [`pagination_token(impl Into<String>)`](crate::client::fluent_builders::ListDevices::pagination_token) / [`set_pagination_token(Option<String>)`](crate::client::fluent_builders::ListDevices::set_pagination_token): <p>The pagination token for the list request.</p>
/// - On success, responds with [`ListDevicesOutput`](crate::output::ListDevicesOutput) with field(s):
/// - [`devices(Option<Vec<DeviceType>>)`](crate::output::ListDevicesOutput::devices): <p>The devices returned in the list devices response.</p>
/// - [`pagination_token(Option<String>)`](crate::output::ListDevicesOutput::pagination_token): <p>The pagination token for the list device response.</p>
/// - On failure, responds with [`SdkError<ListDevicesError>`](crate::error::ListDevicesError)
pub fn list_devices(&self) -> fluent_builders::ListDevices {
fluent_builders::ListDevices::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListGroups`](crate::client::fluent_builders::ListGroups) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListGroups::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListGroups::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListGroups::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListGroups::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListGroups::set_limit): <p>The limit of the request to list groups.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListGroups::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListGroups::set_next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On success, responds with [`ListGroupsOutput`](crate::output::ListGroupsOutput) with field(s):
/// - [`groups(Option<Vec<GroupType>>)`](crate::output::ListGroupsOutput::groups): <p>The group objects for the groups.</p>
/// - [`next_token(Option<String>)`](crate::output::ListGroupsOutput::next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On failure, responds with [`SdkError<ListGroupsError>`](crate::error::ListGroupsError)
pub fn list_groups(&self) -> fluent_builders::ListGroups {
fluent_builders::ListGroups::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListIdentityProviders`](crate::client::fluent_builders::ListIdentityProviders) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListIdentityProviders::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListIdentityProviders::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListIdentityProviders::set_user_pool_id): <p>The user pool ID.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListIdentityProviders::max_results) / [`set_max_results(Option<i32>)`](crate::client::fluent_builders::ListIdentityProviders::set_max_results): <p>The maximum number of IdPs to return.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListIdentityProviders::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListIdentityProviders::set_next_token): <p>A pagination token.</p>
/// - On success, responds with [`ListIdentityProvidersOutput`](crate::output::ListIdentityProvidersOutput) with field(s):
/// - [`providers(Option<Vec<ProviderDescription>>)`](crate::output::ListIdentityProvidersOutput::providers): <p>A list of IdP objects.</p>
/// - [`next_token(Option<String>)`](crate::output::ListIdentityProvidersOutput::next_token): <p>A pagination token.</p>
/// - On failure, responds with [`SdkError<ListIdentityProvidersError>`](crate::error::ListIdentityProvidersError)
pub fn list_identity_providers(&self) -> fluent_builders::ListIdentityProviders {
fluent_builders::ListIdentityProviders::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListResourceServers`](crate::client::fluent_builders::ListResourceServers) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListResourceServers::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListResourceServers::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListResourceServers::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListResourceServers::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListResourceServers::set_max_results): <p>The maximum number of resource servers to return.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListResourceServers::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListResourceServers::set_next_token): <p>A pagination token.</p>
/// - On success, responds with [`ListResourceServersOutput`](crate::output::ListResourceServersOutput) with field(s):
/// - [`resource_servers(Option<Vec<ResourceServerType>>)`](crate::output::ListResourceServersOutput::resource_servers): <p>The resource servers.</p>
/// - [`next_token(Option<String>)`](crate::output::ListResourceServersOutput::next_token): <p>A pagination token.</p>
/// - On failure, responds with [`SdkError<ListResourceServersError>`](crate::error::ListResourceServersError)
pub fn list_resource_servers(&self) -> fluent_builders::ListResourceServers {
fluent_builders::ListResourceServers::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListTagsForResource`](crate::client::fluent_builders::ListTagsForResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::ListTagsForResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::ListTagsForResource::set_resource_arn): <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
/// - On success, responds with [`ListTagsForResourceOutput`](crate::output::ListTagsForResourceOutput) with field(s):
/// - [`tags(Option<HashMap<String, String>>)`](crate::output::ListTagsForResourceOutput::tags): <p>The tags that are assigned to the user pool.</p>
/// - On failure, responds with [`SdkError<ListTagsForResourceError>`](crate::error::ListTagsForResourceError)
pub fn list_tags_for_resource(&self) -> fluent_builders::ListTagsForResource {
fluent_builders::ListTagsForResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListUserImportJobs`](crate::client::fluent_builders::ListUserImportJobs) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListUserImportJobs::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListUserImportJobs::set_user_pool_id): <p>The user pool ID for the user pool that the users are being imported into.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListUserImportJobs::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListUserImportJobs::set_max_results): <p>The maximum number of import jobs you want the request to return.</p>
/// - [`pagination_token(impl Into<String>)`](crate::client::fluent_builders::ListUserImportJobs::pagination_token) / [`set_pagination_token(Option<String>)`](crate::client::fluent_builders::ListUserImportJobs::set_pagination_token): <p>An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list.</p>
/// - On success, responds with [`ListUserImportJobsOutput`](crate::output::ListUserImportJobsOutput) with field(s):
/// - [`user_import_jobs(Option<Vec<UserImportJobType>>)`](crate::output::ListUserImportJobsOutput::user_import_jobs): <p>The user import jobs.</p>
/// - [`pagination_token(Option<String>)`](crate::output::ListUserImportJobsOutput::pagination_token): <p>An identifier that can be used to return the next set of user import jobs in the list.</p>
/// - On failure, responds with [`SdkError<ListUserImportJobsError>`](crate::error::ListUserImportJobsError)
pub fn list_user_import_jobs(&self) -> fluent_builders::ListUserImportJobs {
fluent_builders::ListUserImportJobs::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListUserPoolClients`](crate::client::fluent_builders::ListUserPoolClients) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListUserPoolClients::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListUserPoolClients::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListUserPoolClients::set_user_pool_id): <p>The user pool ID for the user pool where you want to list user pool clients.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListUserPoolClients::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListUserPoolClients::set_max_results): <p>The maximum number of results you want the request to return when listing the user pool clients.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListUserPoolClients::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListUserPoolClients::set_next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On success, responds with [`ListUserPoolClientsOutput`](crate::output::ListUserPoolClientsOutput) with field(s):
/// - [`user_pool_clients(Option<Vec<UserPoolClientDescription>>)`](crate::output::ListUserPoolClientsOutput::user_pool_clients): <p>The user pool clients in the response that lists user pool clients.</p>
/// - [`next_token(Option<String>)`](crate::output::ListUserPoolClientsOutput::next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On failure, responds with [`SdkError<ListUserPoolClientsError>`](crate::error::ListUserPoolClientsError)
pub fn list_user_pool_clients(&self) -> fluent_builders::ListUserPoolClients {
fluent_builders::ListUserPoolClients::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListUserPools`](crate::client::fluent_builders::ListUserPools) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListUserPools::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListUserPools::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListUserPools::set_next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - [`max_results(i32)`](crate::client::fluent_builders::ListUserPools::max_results) / [`set_max_results(i32)`](crate::client::fluent_builders::ListUserPools::set_max_results): <p>The maximum number of results you want the request to return when listing the user pools.</p>
/// - On success, responds with [`ListUserPoolsOutput`](crate::output::ListUserPoolsOutput) with field(s):
/// - [`user_pools(Option<Vec<UserPoolDescriptionType>>)`](crate::output::ListUserPoolsOutput::user_pools): <p>The user pools from the response to list users.</p>
/// - [`next_token(Option<String>)`](crate::output::ListUserPoolsOutput::next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On failure, responds with [`SdkError<ListUserPoolsError>`](crate::error::ListUserPoolsError)
pub fn list_user_pools(&self) -> fluent_builders::ListUserPools {
fluent_builders::ListUserPools::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListUsers`](crate::client::fluent_builders::ListUsers) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListUsers::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListUsers::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListUsers::set_user_pool_id): <p>The user pool ID for the user pool on which the search should be performed.</p>
/// - [`attributes_to_get(Vec<String>)`](crate::client::fluent_builders::ListUsers::attributes_to_get) / [`set_attributes_to_get(Option<Vec<String>>)`](crate::client::fluent_builders::ListUsers::set_attributes_to_get): <p>An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListUsers::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListUsers::set_limit): <p>Maximum number of users to be returned.</p>
/// - [`pagination_token(impl Into<String>)`](crate::client::fluent_builders::ListUsers::pagination_token) / [`set_pagination_token(Option<String>)`](crate::client::fluent_builders::ListUsers::set_pagination_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - [`filter(impl Into<String>)`](crate::client::fluent_builders::ListUsers::filter) / [`set_filter(Option<String>)`](crate::client::fluent_builders::ListUsers::set_filter): <p>A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "<i>AttributeValue</i>"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "<code>family_name</code> = \"Reddy\"".</p> <ul> <li> <p> <i>AttributeName</i>: The name of the attribute to search for. You can only search for one attribute at a time.</p> </li> <li> <p> <i>Filter-Type</i>: For an exact match, use =, for example, "<code>given_name</code> = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "<code>given_name</code> ^= \"Jon\"". </p> </li> <li> <p> <i>AttributeValue</i>: The attribute value that must be matched for each user.</p> </li> </ul> <p>If the filter string is empty, <code>ListUsers</code> returns all users in the user pool.</p> <p>You can only search for the following standard attributes:</p> <ul> <li> <p> <code>username</code> (case-sensitive)</p> </li> <li> <p> <code>email</code> </p> </li> <li> <p> <code>phone_number</code> </p> </li> <li> <p> <code>name</code> </p> </li> <li> <p> <code>given_name</code> </p> </li> <li> <p> <code>family_name</code> </p> </li> <li> <p> <code>preferred_username</code> </p> </li> <li> <p> <code>cognito:user_status</code> (called <b>Status</b> in the Console) (case-insensitive)</p> </li> <li> <p> <code>status (called <b>Enabled</b> in the Console) (case-sensitive)</code> </p> </li> <li> <p> <code>sub</code> </p> </li> </ul> <p>Custom attributes aren't searchable.</p> <note> <p>You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the <code>--query</code> parameter of the <code>list-users</code> action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result. </p> <p>For more information about server-side and client-side filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">FilteringCLI output</a> in the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Command Line Interface User Guide</a>. </p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api">Searching for Users Using the ListUsers API</a> and <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// - On success, responds with [`ListUsersOutput`](crate::output::ListUsersOutput) with field(s):
/// - [`users(Option<Vec<UserType>>)`](crate::output::ListUsersOutput::users): <p>The users returned in the request to list users.</p>
/// - [`pagination_token(Option<String>)`](crate::output::ListUsersOutput::pagination_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On failure, responds with [`SdkError<ListUsersError>`](crate::error::ListUsersError)
pub fn list_users(&self) -> fluent_builders::ListUsers {
fluent_builders::ListUsers::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListUsersInGroup`](crate::client::fluent_builders::ListUsersInGroup) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListUsersInGroup::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::ListUsersInGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::ListUsersInGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::ListUsersInGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::ListUsersInGroup::set_group_name): <p>The name of the group.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListUsersInGroup::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListUsersInGroup::set_limit): <p>The limit of the request to list users.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListUsersInGroup::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListUsersInGroup::set_next_token): <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
/// - On success, responds with [`ListUsersInGroupOutput`](crate::output::ListUsersInGroupOutput) with field(s):
/// - [`users(Option<Vec<UserType>>)`](crate::output::ListUsersInGroupOutput::users): <p>The users returned in the request to list users.</p>
/// - [`next_token(Option<String>)`](crate::output::ListUsersInGroupOutput::next_token): <p>An identifier that you can use in a later request to return the next set of items in the list.</p>
/// - On failure, responds with [`SdkError<ListUsersInGroupError>`](crate::error::ListUsersInGroupError)
pub fn list_users_in_group(&self) -> fluent_builders::ListUsersInGroup {
fluent_builders::ListUsersInGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ResendConfirmationCode`](crate::client::fluent_builders::ResendConfirmationCode) operation.
///
/// - The fluent builder is configurable:
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::ResendConfirmationCode::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::ResendConfirmationCode::set_client_id): <p>The ID of the client associated with the user pool.</p>
/// - [`secret_hash(impl Into<String>)`](crate::client::fluent_builders::ResendConfirmationCode::secret_hash) / [`set_secret_hash(Option<String>)`](crate::client::fluent_builders::ResendConfirmationCode::set_secret_hash): <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::ResendConfirmationCode::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::ResendConfirmationCode::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::ResendConfirmationCode::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::ResendConfirmationCode::set_username): <p>The <code>username</code> attribute of the user to whom you want to resend a confirmation code.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::ResendConfirmationCode::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::ResendConfirmationCode::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>ResendConfirmationCode</code> calls.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::ResendConfirmationCode::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::ResendConfirmationCode::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`ResendConfirmationCodeOutput`](crate::output::ResendConfirmationCodeOutput) with field(s):
/// - [`code_delivery_details(Option<CodeDeliveryDetailsType>)`](crate::output::ResendConfirmationCodeOutput::code_delivery_details): <p>The code delivery details returned by the server in response to the request to resend the confirmation code.</p>
/// - On failure, responds with [`SdkError<ResendConfirmationCodeError>`](crate::error::ResendConfirmationCodeError)
pub fn resend_confirmation_code(&self) -> fluent_builders::ResendConfirmationCode {
fluent_builders::ResendConfirmationCode::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`RespondToAuthChallenge`](crate::client::fluent_builders::RespondToAuthChallenge) operation.
///
/// - The fluent builder is configurable:
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::RespondToAuthChallenge::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_client_id): <p>The app client ID.</p>
/// - [`challenge_name(ChallengeNameType)`](crate::client::fluent_builders::RespondToAuthChallenge::challenge_name) / [`set_challenge_name(Option<ChallengeNameType>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_challenge_name): <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p> <p> <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
/// - [`session(impl Into<String>)`](crate::client::fluent_builders::RespondToAuthChallenge::session) / [`set_session(Option<String>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_session): <p>The session that should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
/// - [`challenge_responses(HashMap<String, String>)`](crate::client::fluent_builders::RespondToAuthChallenge::challenge_responses) / [`set_challenge_responses(Option<HashMap<String, String>>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_challenge_responses): <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <note> <p> <code>SECRET_HASH</code> (if app client is configured with client secret) applies to all of the inputs that follow (including <code>SOFTWARE_TOKEN_MFA</code>).</p> </note> <ul> <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>.</p> <note> <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when you sign in with a remembered device.</p> </note> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>InitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren't required by your user pool.</p> <note> <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p> </note> </li> <li> <p> <code>SOFTWARE_TOKEN_MFA</code>: <code>USERNAME</code> and <code>SOFTWARE_TOKEN_MFA_CODE</code> are required attributes.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code> requires <code>USERNAME</code>, <code>DEVICE_KEY</code>, <code>SRP_A</code> (and <code>SECRET_HASH</code>).</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code> requires everything that <code>PASSWORD_VERIFIER</code> requires, plus <code>DEVICE_KEY</code>.</p> </li> <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li> </ul>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::RespondToAuthChallenge::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>RespondToAuthChallenge</code> calls.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::RespondToAuthChallenge::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::RespondToAuthChallenge::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::RespondToAuthChallenge::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>post authentication</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`RespondToAuthChallengeOutput`](crate::output::RespondToAuthChallengeOutput) with field(s):
/// - [`challenge_name(Option<ChallengeNameType>)`](crate::output::RespondToAuthChallengeOutput::challenge_name): <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
/// - [`session(Option<String>)`](crate::output::RespondToAuthChallengeOutput::session): <p>The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
/// - [`challenge_parameters(Option<HashMap<String, String>>)`](crate::output::RespondToAuthChallengeOutput::challenge_parameters): <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
/// - [`authentication_result(Option<AuthenticationResultType>)`](crate::output::RespondToAuthChallengeOutput::authentication_result): <p>The result returned by the server in response to the request to respond to the authentication challenge.</p>
/// - On failure, responds with [`SdkError<RespondToAuthChallengeError>`](crate::error::RespondToAuthChallengeError)
pub fn respond_to_auth_challenge(&self) -> fluent_builders::RespondToAuthChallenge {
fluent_builders::RespondToAuthChallenge::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`RevokeToken`](crate::client::fluent_builders::RevokeToken) operation.
///
/// - The fluent builder is configurable:
/// - [`token(impl Into<String>)`](crate::client::fluent_builders::RevokeToken::token) / [`set_token(Option<String>)`](crate::client::fluent_builders::RevokeToken::set_token): <p>The refresh token that you want to revoke.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::RevokeToken::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::RevokeToken::set_client_id): <p>The client ID for the token that you want to revoke.</p>
/// - [`client_secret(impl Into<String>)`](crate::client::fluent_builders::RevokeToken::client_secret) / [`set_client_secret(Option<String>)`](crate::client::fluent_builders::RevokeToken::set_client_secret): <p>The secret for the client ID. This is required only if the client ID has a secret.</p>
/// - On success, responds with [`RevokeTokenOutput`](crate::output::RevokeTokenOutput)
/// - On failure, responds with [`SdkError<RevokeTokenError>`](crate::error::RevokeTokenError)
pub fn revoke_token(&self) -> fluent_builders::RevokeToken {
fluent_builders::RevokeToken::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetRiskConfiguration`](crate::client::fluent_builders::SetRiskConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::SetRiskConfiguration::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::SetRiskConfiguration::set_user_pool_id): <p>The user pool ID. </p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::SetRiskConfiguration::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::SetRiskConfiguration::set_client_id): <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is mapped to <code>userPoolId</code>. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.</p> <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.</p>
/// - [`compromised_credentials_risk_configuration(CompromisedCredentialsRiskConfigurationType)`](crate::client::fluent_builders::SetRiskConfiguration::compromised_credentials_risk_configuration) / [`set_compromised_credentials_risk_configuration(Option<CompromisedCredentialsRiskConfigurationType>)`](crate::client::fluent_builders::SetRiskConfiguration::set_compromised_credentials_risk_configuration): <p>The compromised credentials risk configuration.</p>
/// - [`account_takeover_risk_configuration(AccountTakeoverRiskConfigurationType)`](crate::client::fluent_builders::SetRiskConfiguration::account_takeover_risk_configuration) / [`set_account_takeover_risk_configuration(Option<AccountTakeoverRiskConfigurationType>)`](crate::client::fluent_builders::SetRiskConfiguration::set_account_takeover_risk_configuration): <p>The account takeover risk configuration.</p>
/// - [`risk_exception_configuration(RiskExceptionConfigurationType)`](crate::client::fluent_builders::SetRiskConfiguration::risk_exception_configuration) / [`set_risk_exception_configuration(Option<RiskExceptionConfigurationType>)`](crate::client::fluent_builders::SetRiskConfiguration::set_risk_exception_configuration): <p>The configuration to override the risk decision.</p>
/// - On success, responds with [`SetRiskConfigurationOutput`](crate::output::SetRiskConfigurationOutput) with field(s):
/// - [`risk_configuration(Option<RiskConfigurationType>)`](crate::output::SetRiskConfigurationOutput::risk_configuration): <p>The risk configuration.</p>
/// - On failure, responds with [`SdkError<SetRiskConfigurationError>`](crate::error::SetRiskConfigurationError)
pub fn set_risk_configuration(&self) -> fluent_builders::SetRiskConfiguration {
fluent_builders::SetRiskConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetUICustomization`](crate::client::fluent_builders::SetUICustomization) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::SetUICustomization::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::SetUICustomization::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::SetUICustomization::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::SetUICustomization::set_client_id): <p>The client ID for the client app.</p>
/// - [`css(impl Into<String>)`](crate::client::fluent_builders::SetUICustomization::css) / [`set_css(Option<String>)`](crate::client::fluent_builders::SetUICustomization::set_css): <p>The CSS values in the UI customization.</p>
/// - [`image_file(Blob)`](crate::client::fluent_builders::SetUICustomization::image_file) / [`set_image_file(Option<Blob>)`](crate::client::fluent_builders::SetUICustomization::set_image_file): <p>The uploaded logo image for the UI customization.</p>
/// - On success, responds with [`SetUiCustomizationOutput`](crate::output::SetUiCustomizationOutput) with field(s):
/// - [`ui_customization(Option<UiCustomizationType>)`](crate::output::SetUiCustomizationOutput::ui_customization): <p>The UI customization information.</p>
/// - On failure, responds with [`SdkError<SetUICustomizationError>`](crate::error::SetUICustomizationError)
pub fn set_ui_customization(&self) -> fluent_builders::SetUICustomization {
fluent_builders::SetUICustomization::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetUserMFAPreference`](crate::client::fluent_builders::SetUserMFAPreference) operation.
///
/// - The fluent builder is configurable:
/// - [`sms_mfa_settings(SmsMfaSettingsType)`](crate::client::fluent_builders::SetUserMFAPreference::sms_mfa_settings) / [`set_sms_mfa_settings(Option<SmsMfaSettingsType>)`](crate::client::fluent_builders::SetUserMFAPreference::set_sms_mfa_settings): <p>The SMS text message multi-factor authentication (MFA) settings.</p>
/// - [`software_token_mfa_settings(SoftwareTokenMfaSettingsType)`](crate::client::fluent_builders::SetUserMFAPreference::software_token_mfa_settings) / [`set_software_token_mfa_settings(Option<SoftwareTokenMfaSettingsType>)`](crate::client::fluent_builders::SetUserMFAPreference::set_software_token_mfa_settings): <p>The time-based one-time password (TOTP) software token MFA settings.</p>
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::SetUserMFAPreference::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::SetUserMFAPreference::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.</p>
/// - On success, responds with [`SetUserMfaPreferenceOutput`](crate::output::SetUserMfaPreferenceOutput)
/// - On failure, responds with [`SdkError<SetUserMFAPreferenceError>`](crate::error::SetUserMFAPreferenceError)
pub fn set_user_mfa_preference(&self) -> fluent_builders::SetUserMFAPreference {
fluent_builders::SetUserMFAPreference::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetUserPoolMfaConfig`](crate::client::fluent_builders::SetUserPoolMfaConfig) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::SetUserPoolMfaConfig::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::SetUserPoolMfaConfig::set_user_pool_id): <p>The user pool ID.</p>
/// - [`sms_mfa_configuration(SmsMfaConfigType)`](crate::client::fluent_builders::SetUserPoolMfaConfig::sms_mfa_configuration) / [`set_sms_mfa_configuration(Option<SmsMfaConfigType>)`](crate::client::fluent_builders::SetUserPoolMfaConfig::set_sms_mfa_configuration): <p>The SMS text message MFA configuration.</p>
/// - [`software_token_mfa_configuration(SoftwareTokenMfaConfigType)`](crate::client::fluent_builders::SetUserPoolMfaConfig::software_token_mfa_configuration) / [`set_software_token_mfa_configuration(Option<SoftwareTokenMfaConfigType>)`](crate::client::fluent_builders::SetUserPoolMfaConfig::set_software_token_mfa_configuration): <p>The software token MFA configuration.</p>
/// - [`mfa_configuration(UserPoolMfaType)`](crate::client::fluent_builders::SetUserPoolMfaConfig::mfa_configuration) / [`set_mfa_configuration(Option<UserPoolMfaType>)`](crate::client::fluent_builders::SetUserPoolMfaConfig::set_mfa_configuration): <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor Authentication (MFA) to a user pool</a>. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li> </ul>
/// - On success, responds with [`SetUserPoolMfaConfigOutput`](crate::output::SetUserPoolMfaConfigOutput) with field(s):
/// - [`sms_mfa_configuration(Option<SmsMfaConfigType>)`](crate::output::SetUserPoolMfaConfigOutput::sms_mfa_configuration): <p>The SMS text message MFA configuration.</p>
/// - [`software_token_mfa_configuration(Option<SoftwareTokenMfaConfigType>)`](crate::output::SetUserPoolMfaConfigOutput::software_token_mfa_configuration): <p>The software token MFA configuration.</p>
/// - [`mfa_configuration(Option<UserPoolMfaType>)`](crate::output::SetUserPoolMfaConfigOutput::mfa_configuration): <p>The MFA configuration. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor enabled.</p> </li> </ul>
/// - On failure, responds with [`SdkError<SetUserPoolMfaConfigError>`](crate::error::SetUserPoolMfaConfigError)
pub fn set_user_pool_mfa_config(&self) -> fluent_builders::SetUserPoolMfaConfig {
fluent_builders::SetUserPoolMfaConfig::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SetUserSettings`](crate::client::fluent_builders::SetUserSettings) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::SetUserSettings::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::SetUserSettings::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.</p>
/// - [`mfa_options(Vec<MfaOptionType>)`](crate::client::fluent_builders::SetUserSettings::mfa_options) / [`set_mfa_options(Option<Vec<MfaOptionType>>)`](crate::client::fluent_builders::SetUserSettings::set_mfa_options): <p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>
/// - On success, responds with [`SetUserSettingsOutput`](crate::output::SetUserSettingsOutput)
/// - On failure, responds with [`SdkError<SetUserSettingsError>`](crate::error::SetUserSettingsError)
pub fn set_user_settings(&self) -> fluent_builders::SetUserSettings {
fluent_builders::SetUserSettings::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SignUp`](crate::client::fluent_builders::SignUp) operation.
///
/// - The fluent builder is configurable:
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::SignUp::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::SignUp::set_client_id): <p>The ID of the client associated with the user pool.</p>
/// - [`secret_hash(impl Into<String>)`](crate::client::fluent_builders::SignUp::secret_hash) / [`set_secret_hash(Option<String>)`](crate::client::fluent_builders::SignUp::set_secret_hash): <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::SignUp::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::SignUp::set_username): <p>The user name of the user you want to register.</p>
/// - [`password(impl Into<String>)`](crate::client::fluent_builders::SignUp::password) / [`set_password(Option<String>)`](crate::client::fluent_builders::SignUp::set_password): <p>The password of the user you want to register.</p>
/// - [`user_attributes(Vec<AttributeType>)`](crate::client::fluent_builders::SignUp::user_attributes) / [`set_user_attributes(Option<Vec<AttributeType>>)`](crate::client::fluent_builders::SignUp::set_user_attributes): <p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// - [`validation_data(Vec<AttributeType>)`](crate::client::fluent_builders::SignUp::validation_data) / [`set_validation_data(Option<Vec<AttributeType>>)`](crate::client::fluent_builders::SignUp::set_validation_data): <p>The validation data in the request to register a user.</p>
/// - [`analytics_metadata(AnalyticsMetadataType)`](crate::client::fluent_builders::SignUp::analytics_metadata) / [`set_analytics_metadata(Option<AnalyticsMetadataType>)`](crate::client::fluent_builders::SignUp::set_analytics_metadata): <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>SignUp</code> calls.</p>
/// - [`user_context_data(UserContextDataType)`](crate::client::fluent_builders::SignUp::user_context_data) / [`set_user_context_data(Option<UserContextDataType>)`](crate::client::fluent_builders::SignUp::set_user_context_data): <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::SignUp::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::SignUp::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`SignUpOutput`](crate::output::SignUpOutput) with field(s):
/// - [`user_confirmed(bool)`](crate::output::SignUpOutput::user_confirmed): <p>A response from the server indicating that a user registration has been confirmed.</p>
/// - [`code_delivery_details(Option<CodeDeliveryDetailsType>)`](crate::output::SignUpOutput::code_delivery_details): <p>The code delivery details returned by the server response to the user registration request.</p>
/// - [`user_sub(Option<String>)`](crate::output::SignUpOutput::user_sub): <p>The UUID of the authenticated user. This isn't the same as <code>username</code>.</p>
/// - On failure, responds with [`SdkError<SignUpError>`](crate::error::SignUpError)
pub fn sign_up(&self) -> fluent_builders::SignUp {
fluent_builders::SignUp::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StartUserImportJob`](crate::client::fluent_builders::StartUserImportJob) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::StartUserImportJob::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::StartUserImportJob::set_user_pool_id): <p>The user pool ID for the user pool that the users are being imported into.</p>
/// - [`job_id(impl Into<String>)`](crate::client::fluent_builders::StartUserImportJob::job_id) / [`set_job_id(Option<String>)`](crate::client::fluent_builders::StartUserImportJob::set_job_id): <p>The job ID for the user import job.</p>
/// - On success, responds with [`StartUserImportJobOutput`](crate::output::StartUserImportJobOutput) with field(s):
/// - [`user_import_job(Option<UserImportJobType>)`](crate::output::StartUserImportJobOutput::user_import_job): <p>The job object that represents the user import job.</p>
/// - On failure, responds with [`SdkError<StartUserImportJobError>`](crate::error::StartUserImportJobError)
pub fn start_user_import_job(&self) -> fluent_builders::StartUserImportJob {
fluent_builders::StartUserImportJob::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StopUserImportJob`](crate::client::fluent_builders::StopUserImportJob) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::StopUserImportJob::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::StopUserImportJob::set_user_pool_id): <p>The user pool ID for the user pool that the users are being imported into.</p>
/// - [`job_id(impl Into<String>)`](crate::client::fluent_builders::StopUserImportJob::job_id) / [`set_job_id(Option<String>)`](crate::client::fluent_builders::StopUserImportJob::set_job_id): <p>The job ID for the user import job.</p>
/// - On success, responds with [`StopUserImportJobOutput`](crate::output::StopUserImportJobOutput) with field(s):
/// - [`user_import_job(Option<UserImportJobType>)`](crate::output::StopUserImportJobOutput::user_import_job): <p>The job object that represents the user import job.</p>
/// - On failure, responds with [`SdkError<StopUserImportJobError>`](crate::error::StopUserImportJobError)
pub fn stop_user_import_job(&self) -> fluent_builders::StopUserImportJob {
fluent_builders::StopUserImportJob::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`TagResource`](crate::client::fluent_builders::TagResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::TagResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::TagResource::set_resource_arn): <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
/// - [`tags(HashMap<String, String>)`](crate::client::fluent_builders::TagResource::tags) / [`set_tags(Option<HashMap<String, String>>)`](crate::client::fluent_builders::TagResource::set_tags): <p>The tags to assign to the user pool.</p>
/// - On success, responds with [`TagResourceOutput`](crate::output::TagResourceOutput)
/// - On failure, responds with [`SdkError<TagResourceError>`](crate::error::TagResourceError)
pub fn tag_resource(&self) -> fluent_builders::TagResource {
fluent_builders::TagResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UntagResource`](crate::client::fluent_builders::UntagResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::UntagResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::UntagResource::set_resource_arn): <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
/// - [`tag_keys(Vec<String>)`](crate::client::fluent_builders::UntagResource::tag_keys) / [`set_tag_keys(Option<Vec<String>>)`](crate::client::fluent_builders::UntagResource::set_tag_keys): <p>The keys of the tags to remove from the user pool.</p>
/// - On success, responds with [`UntagResourceOutput`](crate::output::UntagResourceOutput)
/// - On failure, responds with [`SdkError<UntagResourceError>`](crate::error::UntagResourceError)
pub fn untag_resource(&self) -> fluent_builders::UntagResource {
fluent_builders::UntagResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateAuthEventFeedback`](crate::client::fluent_builders::UpdateAuthEventFeedback) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::set_user_pool_id): <p>The user pool ID.</p>
/// - [`username(impl Into<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::username) / [`set_username(Option<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::set_username): <p>The user pool username.</p>
/// - [`event_id(impl Into<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::event_id) / [`set_event_id(Option<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::set_event_id): <p>The event ID.</p>
/// - [`feedback_token(impl Into<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::feedback_token) / [`set_feedback_token(Option<String>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::set_feedback_token): <p>The feedback token.</p>
/// - [`feedback_value(FeedbackValueType)`](crate::client::fluent_builders::UpdateAuthEventFeedback::feedback_value) / [`set_feedback_value(Option<FeedbackValueType>)`](crate::client::fluent_builders::UpdateAuthEventFeedback::set_feedback_value): <p>The authentication event feedback value.</p>
/// - On success, responds with [`UpdateAuthEventFeedbackOutput`](crate::output::UpdateAuthEventFeedbackOutput)
/// - On failure, responds with [`SdkError<UpdateAuthEventFeedbackError>`](crate::error::UpdateAuthEventFeedbackError)
pub fn update_auth_event_feedback(&self) -> fluent_builders::UpdateAuthEventFeedback {
fluent_builders::UpdateAuthEventFeedback::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateDeviceStatus`](crate::client::fluent_builders::UpdateDeviceStatus) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::UpdateDeviceStatus::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::UpdateDeviceStatus::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose device status you want to update.</p>
/// - [`device_key(impl Into<String>)`](crate::client::fluent_builders::UpdateDeviceStatus::device_key) / [`set_device_key(Option<String>)`](crate::client::fluent_builders::UpdateDeviceStatus::set_device_key): <p>The device key.</p>
/// - [`device_remembered_status(DeviceRememberedStatusType)`](crate::client::fluent_builders::UpdateDeviceStatus::device_remembered_status) / [`set_device_remembered_status(Option<DeviceRememberedStatusType>)`](crate::client::fluent_builders::UpdateDeviceStatus::set_device_remembered_status): <p>The status of whether a device is remembered.</p>
/// - On success, responds with [`UpdateDeviceStatusOutput`](crate::output::UpdateDeviceStatusOutput)
/// - On failure, responds with [`SdkError<UpdateDeviceStatusError>`](crate::error::UpdateDeviceStatusError)
pub fn update_device_status(&self) -> fluent_builders::UpdateDeviceStatus {
fluent_builders::UpdateDeviceStatus::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateGroup`](crate::client::fluent_builders::UpdateGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`group_name(impl Into<String>)`](crate::client::fluent_builders::UpdateGroup::group_name) / [`set_group_name(Option<String>)`](crate::client::fluent_builders::UpdateGroup::set_group_name): <p>The name of the group.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateGroup::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateGroup::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::UpdateGroup::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::UpdateGroup::set_description): <p>A string containing the new description of the group.</p>
/// - [`role_arn(impl Into<String>)`](crate::client::fluent_builders::UpdateGroup::role_arn) / [`set_role_arn(Option<String>)`](crate::client::fluent_builders::UpdateGroup::set_role_arn): <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the token.</p>
/// - [`precedence(i32)`](crate::client::fluent_builders::UpdateGroup::precedence) / [`set_precedence(Option<i32>)`](crate::client::fluent_builders::UpdateGroup::set_precedence): <p>The new precedence value for the group. For more information about this parameter, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
/// - On success, responds with [`UpdateGroupOutput`](crate::output::UpdateGroupOutput) with field(s):
/// - [`group(Option<GroupType>)`](crate::output::UpdateGroupOutput::group): <p>The group object for the group.</p>
/// - On failure, responds with [`SdkError<UpdateGroupError>`](crate::error::UpdateGroupError)
pub fn update_group(&self) -> fluent_builders::UpdateGroup {
fluent_builders::UpdateGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateIdentityProvider`](crate::client::fluent_builders::UpdateIdentityProvider) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateIdentityProvider::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateIdentityProvider::set_user_pool_id): <p>The user pool ID.</p>
/// - [`provider_name(impl Into<String>)`](crate::client::fluent_builders::UpdateIdentityProvider::provider_name) / [`set_provider_name(Option<String>)`](crate::client::fluent_builders::UpdateIdentityProvider::set_provider_name): <p>The IdP name.</p>
/// - [`provider_details(HashMap<String, String>)`](crate::client::fluent_builders::UpdateIdentityProvider::provider_details) / [`set_provider_details(Option<HashMap<String, String>>)`](crate::client::fluent_builders::UpdateIdentityProvider::set_provider_details): <p>The IdP details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
/// - [`attribute_mapping(HashMap<String, String>)`](crate::client::fluent_builders::UpdateIdentityProvider::attribute_mapping) / [`set_attribute_mapping(Option<HashMap<String, String>>)`](crate::client::fluent_builders::UpdateIdentityProvider::set_attribute_mapping): <p>The IdP attribute mapping to be changed.</p>
/// - [`idp_identifiers(Vec<String>)`](crate::client::fluent_builders::UpdateIdentityProvider::idp_identifiers) / [`set_idp_identifiers(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateIdentityProvider::set_idp_identifiers): <p>A list of IdP identifiers.</p>
/// - On success, responds with [`UpdateIdentityProviderOutput`](crate::output::UpdateIdentityProviderOutput) with field(s):
/// - [`identity_provider(Option<IdentityProviderType>)`](crate::output::UpdateIdentityProviderOutput::identity_provider): <p>The identity provider details.</p>
/// - On failure, responds with [`SdkError<UpdateIdentityProviderError>`](crate::error::UpdateIdentityProviderError)
pub fn update_identity_provider(&self) -> fluent_builders::UpdateIdentityProvider {
fluent_builders::UpdateIdentityProvider::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateResourceServer`](crate::client::fluent_builders::UpdateResourceServer) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateResourceServer::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateResourceServer::set_user_pool_id): <p>The user pool ID for the user pool.</p>
/// - [`identifier(impl Into<String>)`](crate::client::fluent_builders::UpdateResourceServer::identifier) / [`set_identifier(Option<String>)`](crate::client::fluent_builders::UpdateResourceServer::set_identifier): <p>The identifier for the resource server.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateResourceServer::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateResourceServer::set_name): <p>The name of the resource server.</p>
/// - [`scopes(Vec<ResourceServerScopeType>)`](crate::client::fluent_builders::UpdateResourceServer::scopes) / [`set_scopes(Option<Vec<ResourceServerScopeType>>)`](crate::client::fluent_builders::UpdateResourceServer::set_scopes): <p>The scope values to be set for the resource server.</p>
/// - On success, responds with [`UpdateResourceServerOutput`](crate::output::UpdateResourceServerOutput) with field(s):
/// - [`resource_server(Option<ResourceServerType>)`](crate::output::UpdateResourceServerOutput::resource_server): <p>The resource server.</p>
/// - On failure, responds with [`SdkError<UpdateResourceServerError>`](crate::error::UpdateResourceServerError)
pub fn update_resource_server(&self) -> fluent_builders::UpdateResourceServer {
fluent_builders::UpdateResourceServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateUserAttributes`](crate::client::fluent_builders::UpdateUserAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`user_attributes(Vec<AttributeType>)`](crate::client::fluent_builders::UpdateUserAttributes::user_attributes) / [`set_user_attributes(Option<Vec<AttributeType>>)`](crate::client::fluent_builders::UpdateUserAttributes::set_user_attributes): <p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p> <p>If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.</p>
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::UpdateUserAttributes::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::UpdateUserAttributes::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.</p>
/// - [`client_metadata(HashMap<String, String>)`](crate::client::fluent_builders::UpdateUserAttributes::client_metadata) / [`set_client_metadata(Option<HashMap<String, String>>)`](crate::client::fluent_builders::UpdateUserAttributes::set_client_metadata): <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. </p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>
/// - On success, responds with [`UpdateUserAttributesOutput`](crate::output::UpdateUserAttributesOutput) with field(s):
/// - [`code_delivery_details_list(Option<Vec<CodeDeliveryDetailsType>>)`](crate::output::UpdateUserAttributesOutput::code_delivery_details_list): <p>The code delivery details list from the server for the request to update user attributes.</p>
/// - On failure, responds with [`SdkError<UpdateUserAttributesError>`](crate::error::UpdateUserAttributesError)
pub fn update_user_attributes(&self) -> fluent_builders::UpdateUserAttributes {
fluent_builders::UpdateUserAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateUserPool`](crate::client::fluent_builders::UpdateUserPool) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPool::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateUserPool::set_user_pool_id): <p>The user pool ID for the user pool you want to update.</p>
/// - [`policies(UserPoolPolicyType)`](crate::client::fluent_builders::UpdateUserPool::policies) / [`set_policies(Option<UserPoolPolicyType>)`](crate::client::fluent_builders::UpdateUserPool::set_policies): <p>A container with the policies you want to update in a user pool.</p>
/// - [`deletion_protection(DeletionProtectionType)`](crate::client::fluent_builders::UpdateUserPool::deletion_protection) / [`set_deletion_protection(Option<DeletionProtectionType>)`](crate::client::fluent_builders::UpdateUserPool::set_deletion_protection): <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p> <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
/// - [`lambda_config(LambdaConfigType)`](crate::client::fluent_builders::UpdateUserPool::lambda_config) / [`set_lambda_config(Option<LambdaConfigType>)`](crate::client::fluent_builders::UpdateUserPool::set_lambda_config): <p>The Lambda configuration information from the request to update the user pool.</p>
/// - [`auto_verified_attributes(Vec<VerifiedAttributeType>)`](crate::client::fluent_builders::UpdateUserPool::auto_verified_attributes) / [`set_auto_verified_attributes(Option<Vec<VerifiedAttributeType>>)`](crate::client::fluent_builders::UpdateUserPool::set_auto_verified_attributes): <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
/// - [`sms_verification_message(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPool::sms_verification_message) / [`set_sms_verification_message(Option<String>)`](crate::client::fluent_builders::UpdateUserPool::set_sms_verification_message): <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
/// - [`email_verification_message(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPool::email_verification_message) / [`set_email_verification_message(Option<String>)`](crate::client::fluent_builders::UpdateUserPool::set_email_verification_message): <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
/// - [`email_verification_subject(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPool::email_verification_subject) / [`set_email_verification_subject(Option<String>)`](crate::client::fluent_builders::UpdateUserPool::set_email_verification_subject): <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
/// - [`verification_message_template(VerificationMessageTemplateType)`](crate::client::fluent_builders::UpdateUserPool::verification_message_template) / [`set_verification_message_template(Option<VerificationMessageTemplateType>)`](crate::client::fluent_builders::UpdateUserPool::set_verification_message_template): <p>The template for verification messages.</p>
/// - [`sms_authentication_message(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPool::sms_authentication_message) / [`set_sms_authentication_message(Option<String>)`](crate::client::fluent_builders::UpdateUserPool::set_sms_authentication_message): <p>The contents of the SMS authentication message.</p>
/// - [`user_attribute_update_settings(UserAttributeUpdateSettingsType)`](crate::client::fluent_builders::UpdateUserPool::user_attribute_update_settings) / [`set_user_attribute_update_settings(Option<UserAttributeUpdateSettingsType>)`](crate::client::fluent_builders::UpdateUserPool::set_user_attribute_update_settings): <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
/// - [`mfa_configuration(UserPoolMfaType)`](crate::client::fluent_builders::UpdateUserPool::mfa_configuration) / [`set_mfa_configuration(Option<UserPoolMfaType>)`](crate::client::fluent_builders::UpdateUserPool::set_mfa_configuration): <p>Possible values include:</p> <ul> <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li> <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li> <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li> </ul>
/// - [`device_configuration(DeviceConfigurationType)`](crate::client::fluent_builders::UpdateUserPool::device_configuration) / [`set_device_configuration(Option<DeviceConfigurationType>)`](crate::client::fluent_builders::UpdateUserPool::set_device_configuration): <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note> <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p> </note>
/// - [`email_configuration(EmailConfigurationType)`](crate::client::fluent_builders::UpdateUserPool::email_configuration) / [`set_email_configuration(Option<EmailConfigurationType>)`](crate::client::fluent_builders::UpdateUserPool::set_email_configuration): <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>
/// - [`sms_configuration(SmsConfigurationType)`](crate::client::fluent_builders::UpdateUserPool::sms_configuration) / [`set_sms_configuration(Option<SmsConfigurationType>)`](crate::client::fluent_builders::UpdateUserPool::set_sms_configuration): <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
/// - [`user_pool_tags(HashMap<String, String>)`](crate::client::fluent_builders::UpdateUserPool::user_pool_tags) / [`set_user_pool_tags(Option<HashMap<String, String>>)`](crate::client::fluent_builders::UpdateUserPool::set_user_pool_tags): <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
/// - [`admin_create_user_config(AdminCreateUserConfigType)`](crate::client::fluent_builders::UpdateUserPool::admin_create_user_config) / [`set_admin_create_user_config(Option<AdminCreateUserConfigType>)`](crate::client::fluent_builders::UpdateUserPool::set_admin_create_user_config): <p>The configuration for <code>AdminCreateUser</code> requests.</p>
/// - [`user_pool_add_ons(UserPoolAddOnsType)`](crate::client::fluent_builders::UpdateUserPool::user_pool_add_ons) / [`set_user_pool_add_ons(Option<UserPoolAddOnsType>)`](crate::client::fluent_builders::UpdateUserPool::set_user_pool_add_ons): <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
/// - [`account_recovery_setting(AccountRecoverySettingType)`](crate::client::fluent_builders::UpdateUserPool::account_recovery_setting) / [`set_account_recovery_setting(Option<AccountRecoverySettingType>)`](crate::client::fluent_builders::UpdateUserPool::set_account_recovery_setting): <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
/// - On success, responds with [`UpdateUserPoolOutput`](crate::output::UpdateUserPoolOutput)
/// - On failure, responds with [`SdkError<UpdateUserPoolError>`](crate::error::UpdateUserPoolError)
pub fn update_user_pool(&self) -> fluent_builders::UpdateUserPool {
fluent_builders::UpdateUserPool::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateUserPoolClient`](crate::client::fluent_builders::UpdateUserPoolClient) operation.
///
/// - The fluent builder is configurable:
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_user_pool_id): <p>The user pool ID for the user pool where you want to update the user pool client.</p>
/// - [`client_id(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::client_id) / [`set_client_id(Option<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_client_id): <p>The ID of the client associated with the user pool.</p>
/// - [`client_name(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::client_name) / [`set_client_name(Option<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_client_name): <p>The client name from the update user pool client request.</p>
/// - [`refresh_token_validity(i32)`](crate::client::fluent_builders::UpdateUserPoolClient::refresh_token_validity) / [`set_refresh_token_validity(i32)`](crate::client::fluent_builders::UpdateUserPoolClient::set_refresh_token_validity): <p>The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p> <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session and retrieve new access and ID tokens for 10 days.</p> <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days. You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. <i>Valid range</i> is displayed below in seconds.</p> <p>If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.</p>
/// - [`access_token_validity(i32)`](crate::client::fluent_builders::UpdateUserPoolClient::access_token_validity) / [`set_access_token_validity(Option<i32>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_access_token_validity): <p>The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for <code>AccessTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p> <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with their access token for 10 hours.</p> <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p> <p>If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.</p>
/// - [`id_token_validity(i32)`](crate::client::fluent_builders::UpdateUserPoolClient::id_token_validity) / [`set_id_token_validity(Option<i32>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_id_token_validity): <p>The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for <code>IdTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p> <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their session with their ID token for 10 hours.</p> <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p> <p>If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.</p>
/// - [`token_validity_units(TokenValidityUnitsType)`](crate::client::fluent_builders::UpdateUserPoolClient::token_validity_units) / [`set_token_validity_units(Option<TokenValidityUnitsType>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_token_validity_units): <p>The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.</p>
/// - [`read_attributes(Vec<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::read_attributes) / [`set_read_attributes(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_read_attributes): <p>The read-only attributes of the user pool.</p>
/// - [`write_attributes(Vec<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::write_attributes) / [`set_write_attributes(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_write_attributes): <p>The writeable attributes of the user pool.</p>
/// - [`explicit_auth_flows(Vec<ExplicitAuthFlowsType>)`](crate::client::fluent_builders::UpdateUserPoolClient::explicit_auth_flows) / [`set_explicit_auth_flows(Option<Vec<ExplicitAuthFlowsType>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_explicit_auth_flows): <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.</p> <note> <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p> </note> <p>Valid values include:</p> <ul> <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.</p> </li> <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li> <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li> <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li> <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li> </ul> <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>. You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>, like <code>ALLOW_USER_SRP_AUTH</code>.</p>
/// - [`supported_identity_providers(Vec<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::supported_identity_providers) / [`set_supported_identity_providers(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_supported_identity_providers): <p>A list of provider names for the IdPs that this client supports. The following are supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>, <code>LoginWithAmazon</code>, and the names of your own SAML and OIDC providers.</p>
/// - [`callback_ur_ls(Vec<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::callback_ur_ls) / [`set_callback_ur_ls(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_callback_ur_ls): <p>A list of allowed redirect (callback) URLs for the IdPs.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p> <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p> <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
/// - [`logout_ur_ls(Vec<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::logout_ur_ls) / [`set_logout_ur_ls(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_logout_ur_ls): <p>A list of allowed logout URLs for the IdPs.</p>
/// - [`default_redirect_uri(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::default_redirect_uri) / [`set_default_redirect_uri(Option<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_default_redirect_uri): <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p> <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing purposes only.</p> <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
/// - [`allowed_o_auth_flows(Vec<OAuthFlowType>)`](crate::client::fluent_builders::UpdateUserPoolClient::allowed_o_auth_flows) / [`set_allowed_o_auth_flows(Option<Vec<OAuthFlowType>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_allowed_o_auth_flows): <p>The allowed OAuth flows.</p> <dl> <dt> code </dt> <dd> <p>Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the <code>/oauth2/token</code> endpoint.</p> </dd> <dt> implicit </dt> <dd> <p>Issue the access token (and, optionally, ID token, based on scopes) directly to your user.</p> </dd> <dt> client_credentials </dt> <dd> <p>Issue the access token from the <code>/oauth2/token</code> endpoint directly to a non-person user using a combination of the client ID and client secret.</p> </dd> </dl>
/// - [`allowed_o_auth_scopes(Vec<String>)`](crate::client::fluent_builders::UpdateUserPoolClient::allowed_o_auth_scopes) / [`set_allowed_o_auth_scopes(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_allowed_o_auth_scopes): <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>
/// - [`allowed_o_auth_flows_user_pool_client(bool)`](crate::client::fluent_builders::UpdateUserPoolClient::allowed_o_auth_flows_user_pool_client) / [`set_allowed_o_auth_flows_user_pool_client(bool)`](crate::client::fluent_builders::UpdateUserPoolClient::set_allowed_o_auth_flows_user_pool_client): <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
/// - [`analytics_configuration(AnalyticsConfigurationType)`](crate::client::fluent_builders::UpdateUserPoolClient::analytics_configuration) / [`set_analytics_configuration(Option<AnalyticsConfigurationType>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_analytics_configuration): <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.</p> <note> <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p> </note>
/// - [`prevent_user_existence_errors(PreventUserExistenceErrorTypes)`](crate::client::fluent_builders::UpdateUserPoolClient::prevent_user_existence_errors) / [`set_prevent_user_existence_errors(Option<PreventUserExistenceErrorTypes>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_prevent_user_existence_errors): <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.</p> </li> </ul>
/// - [`enable_token_revocation(bool)`](crate::client::fluent_builders::UpdateUserPoolClient::enable_token_revocation) / [`set_enable_token_revocation(Option<bool>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_enable_token_revocation): <p>Activates or deactivates token revocation. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
/// - [`enable_propagate_additional_user_context_data(bool)`](crate::client::fluent_builders::UpdateUserPoolClient::enable_propagate_additional_user_context_data) / [`set_enable_propagate_additional_user_context_data(Option<bool>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_enable_propagate_additional_user_context_data): <p>Activates the propagation of additional user context data. For more information about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a client secret.</p>
/// - [`auth_session_validity(i32)`](crate::client::fluent_builders::UpdateUserPoolClient::auth_session_validity) / [`set_auth_session_validity(Option<i32>)`](crate::client::fluent_builders::UpdateUserPoolClient::set_auth_session_validity): <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
/// - On success, responds with [`UpdateUserPoolClientOutput`](crate::output::UpdateUserPoolClientOutput) with field(s):
/// - [`user_pool_client(Option<UserPoolClientType>)`](crate::output::UpdateUserPoolClientOutput::user_pool_client): <p>The user pool client value from the response from the server when you request to update the user pool client.</p>
/// - On failure, responds with [`SdkError<UpdateUserPoolClientError>`](crate::error::UpdateUserPoolClientError)
pub fn update_user_pool_client(&self) -> fluent_builders::UpdateUserPoolClient {
fluent_builders::UpdateUserPoolClient::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateUserPoolDomain`](crate::client::fluent_builders::UpdateUserPoolDomain) operation.
///
/// - The fluent builder is configurable:
/// - [`domain(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPoolDomain::domain) / [`set_domain(Option<String>)`](crate::client::fluent_builders::UpdateUserPoolDomain::set_domain): <p>The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be <code>auth.example.com</code>. </p> <p>This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.</p>
/// - [`user_pool_id(impl Into<String>)`](crate::client::fluent_builders::UpdateUserPoolDomain::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::client::fluent_builders::UpdateUserPoolDomain::set_user_pool_id): <p>The ID of the user pool that is associated with the custom domain whose certificate you're updating.</p>
/// - [`custom_domain_config(CustomDomainConfigType)`](crate::client::fluent_builders::UpdateUserPoolDomain::custom_domain_config) / [`set_custom_domain_config(Option<CustomDomainConfigType>)`](crate::client::fluent_builders::UpdateUserPoolDomain::set_custom_domain_config): <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.</p>
/// - On success, responds with [`UpdateUserPoolDomainOutput`](crate::output::UpdateUserPoolDomainOutput) with field(s):
/// - [`cloud_front_domain(Option<String>)`](crate::output::UpdateUserPoolDomainOutput::cloud_front_domain): <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.</p>
/// - On failure, responds with [`SdkError<UpdateUserPoolDomainError>`](crate::error::UpdateUserPoolDomainError)
pub fn update_user_pool_domain(&self) -> fluent_builders::UpdateUserPoolDomain {
fluent_builders::UpdateUserPoolDomain::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`VerifySoftwareToken`](crate::client::fluent_builders::VerifySoftwareToken) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::VerifySoftwareToken::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::VerifySoftwareToken::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose software token you want to verify.</p>
/// - [`session(impl Into<String>)`](crate::client::fluent_builders::VerifySoftwareToken::session) / [`set_session(Option<String>)`](crate::client::fluent_builders::VerifySoftwareToken::set_session): <p>The session that should be passed both ways in challenge-response calls to the service.</p>
/// - [`user_code(impl Into<String>)`](crate::client::fluent_builders::VerifySoftwareToken::user_code) / [`set_user_code(Option<String>)`](crate::client::fluent_builders::VerifySoftwareToken::set_user_code): <p>The one- time password computed using the secret code returned by <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a>.</p>
/// - [`friendly_device_name(impl Into<String>)`](crate::client::fluent_builders::VerifySoftwareToken::friendly_device_name) / [`set_friendly_device_name(Option<String>)`](crate::client::fluent_builders::VerifySoftwareToken::set_friendly_device_name): <p>The friendly device name.</p>
/// - On success, responds with [`VerifySoftwareTokenOutput`](crate::output::VerifySoftwareTokenOutput) with field(s):
/// - [`status(Option<VerifySoftwareTokenResponseType>)`](crate::output::VerifySoftwareTokenOutput::status): <p>The status of the verify software token.</p>
/// - [`session(Option<String>)`](crate::output::VerifySoftwareTokenOutput::session): <p>The session that should be passed both ways in challenge-response calls to the service.</p>
/// - On failure, responds with [`SdkError<VerifySoftwareTokenError>`](crate::error::VerifySoftwareTokenError)
pub fn verify_software_token(&self) -> fluent_builders::VerifySoftwareToken {
fluent_builders::VerifySoftwareToken::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`VerifyUserAttribute`](crate::client::fluent_builders::VerifyUserAttribute) operation.
///
/// - The fluent builder is configurable:
/// - [`access_token(impl Into<String>)`](crate::client::fluent_builders::VerifyUserAttribute::access_token) / [`set_access_token(Option<String>)`](crate::client::fluent_builders::VerifyUserAttribute::set_access_token): <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.</p>
/// - [`attribute_name(impl Into<String>)`](crate::client::fluent_builders::VerifyUserAttribute::attribute_name) / [`set_attribute_name(Option<String>)`](crate::client::fluent_builders::VerifyUserAttribute::set_attribute_name): <p>The attribute name in the request to verify user attributes.</p>
/// - [`code(impl Into<String>)`](crate::client::fluent_builders::VerifyUserAttribute::code) / [`set_code(Option<String>)`](crate::client::fluent_builders::VerifyUserAttribute::set_code): <p>The verification code in the request to verify user attributes.</p>
/// - On success, responds with [`VerifyUserAttributeOutput`](crate::output::VerifyUserAttributeOutput)
/// - On failure, responds with [`SdkError<VerifyUserAttributeError>`](crate::error::VerifyUserAttributeError)
pub fn verify_user_attribute(&self) -> fluent_builders::VerifyUserAttribute {
fluent_builders::VerifyUserAttribute::new(self.handle.clone())
}
}
pub mod fluent_builders {
//! Utilities to ergonomically construct a request to the service.
//!
//! Fluent builders are created through the [`Client`](crate::client::Client) by calling
//! one if its operation methods. After parameters are set using the builder methods,
//! the `send` method can be called to initiate the request.
/// Fluent builder constructing a request to `AddCustomAttributes`.
///
/// <p>Adds additional user attributes to the user pool schema.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AddCustomAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::add_custom_attributes_input::Builder,
}
impl AddCustomAttributes {
/// Creates a new `AddCustomAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AddCustomAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AddCustomAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AddCustomAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::AddCustomAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to add custom attributes.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to add custom attributes.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// Appends an item to `CustomAttributes`.
///
/// To override the contents of this collection use [`set_custom_attributes`](Self::set_custom_attributes).
///
/// <p>An array of custom attributes, such as Mutable and Name.</p>
pub fn custom_attributes(mut self, input: crate::model::SchemaAttributeType) -> Self {
self.inner = self.inner.custom_attributes(input);
self
}
/// <p>An array of custom attributes, such as Mutable and Name.</p>
pub fn set_custom_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::SchemaAttributeType>>,
) -> Self {
self.inner = self.inner.set_custom_attributes(input);
self
}
}
/// Fluent builder constructing a request to `AdminAddUserToGroup`.
///
/// <p>Adds the specified user to the specified group.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminAddUserToGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_add_user_to_group_input::Builder,
}
impl AdminAddUserToGroup {
/// Creates a new `AdminAddUserToGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminAddUserToGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminAddUserToGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminAddUserToGroupOutput,
aws_smithy_http::result::SdkError<crate::error::AdminAddUserToGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The username for the user.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The username for the user.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The group name.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The group name.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
}
/// Fluent builder constructing a request to `AdminConfirmSignUp`.
///
/// <p>Confirms user registration as an admin without using a confirmation code. Works on any user.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminConfirmSignUp {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_confirm_sign_up_input::Builder,
}
impl AdminConfirmSignUp {
/// Creates a new `AdminConfirmSignUp`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminConfirmSignUp,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminConfirmSignUpError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminConfirmSignUpOutput,
aws_smithy_http::result::SdkError<crate::error::AdminConfirmSignUpError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for which you want to confirm user registration.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for which you want to confirm user registration.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name for which you want to confirm user registration.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name for which you want to confirm user registration.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the <code>clientMetadata</code> attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the <code>clientMetadata</code> attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `AdminCreateUser`.
///
/// <p>Creates a new user in the specified user pool.</p>
/// <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
/// <p>This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.</p>
/// <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code> for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
/// <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change their password.</p>
/// <p> <code>AdminCreateUser</code> requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminCreateUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_create_user_input::Builder,
}
impl AdminCreateUser {
/// Creates a new `AdminCreateUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminCreateUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminCreateUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminCreateUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminCreateUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where the user will be created.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where the user will be created.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// Appends an item to `UserAttributes`.
///
/// To override the contents of this collection use [`set_user_attributes`](Self::set_user_attributes).
///
/// <p>An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than <code>Username</code>. However, any attributes that you specify as required (when creating a user pool or in the <b>Attributes</b> tab of the console) either you should supply (in your call to <code>AdminCreateUser</code>) or the user should supply (when they sign up in response to your welcome message).</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the <b>Users</b> tab of the Amazon Cognito console for managing your user pools.</p>
/// <p>In your call to <code>AdminCreateUser</code>, you can set the <code>email_verified</code> attribute to <code>True</code>, and you can set the <code>phone_number_verified</code> attribute to <code>True</code>. You can also do this by calling <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a>.</p>
/// <ul>
/// <li> <p> <b>email</b>: The email address of the user to whom the message that contains the code and username will be sent. Required if the <code>email_verified</code> attribute is set to <code>True</code>, or if <code>"EMAIL"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li>
/// <li> <p> <b>phone_number</b>: The phone number of the user to whom the message that contains the code and username will be sent. Required if the <code>phone_number_verified</code> attribute is set to <code>True</code>, or if <code>"SMS"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li>
/// </ul>
pub fn user_attributes(mut self, input: crate::model::AttributeType) -> Self {
self.inner = self.inner.user_attributes(input);
self
}
/// <p>An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than <code>Username</code>. However, any attributes that you specify as required (when creating a user pool or in the <b>Attributes</b> tab of the console) either you should supply (in your call to <code>AdminCreateUser</code>) or the user should supply (when they sign up in response to your welcome message).</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the <b>Users</b> tab of the Amazon Cognito console for managing your user pools.</p>
/// <p>In your call to <code>AdminCreateUser</code>, you can set the <code>email_verified</code> attribute to <code>True</code>, and you can set the <code>phone_number_verified</code> attribute to <code>True</code>. You can also do this by calling <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a>.</p>
/// <ul>
/// <li> <p> <b>email</b>: The email address of the user to whom the message that contains the code and username will be sent. Required if the <code>email_verified</code> attribute is set to <code>True</code>, or if <code>"EMAIL"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li>
/// <li> <p> <b>phone_number</b>: The phone number of the user to whom the message that contains the code and username will be sent. Required if the <code>phone_number_verified</code> attribute is set to <code>True</code>, or if <code>"SMS"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li>
/// </ul>
pub fn set_user_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AttributeType>>,
) -> Self {
self.inner = self.inner.set_user_attributes(input);
self
}
/// Appends an item to `ValidationData`.
///
/// To override the contents of this collection use [`set_validation_data`](Self::set_validation_data).
///
/// <p>The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.</p>
/// <p>To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.</p>
/// <p>The user's validation data isn't persisted.</p>
pub fn validation_data(mut self, input: crate::model::AttributeType) -> Self {
self.inner = self.inner.validation_data(input);
self
}
/// <p>The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.</p>
/// <p>To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.</p>
/// <p>The user's validation data isn't persisted.</p>
pub fn set_validation_data(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AttributeType>>,
) -> Self {
self.inner = self.inner.set_validation_data(input);
self
}
/// <p>The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.</p>
/// <p>The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.</p>
/// <p>This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.</p>
/// <p>The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter.</p>
pub fn temporary_password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.temporary_password(input.into());
self
}
/// <p>The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.</p>
/// <p>The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.</p>
/// <p>This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.</p>
/// <p>The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter.</p>
pub fn set_temporary_password(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_temporary_password(input);
self
}
/// <p>This parameter is used only if the <code>phone_number_verified</code> or <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is ignored.</p>
/// <p>If this parameter is set to <code>True</code> and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.</p>
/// <p>If this parameter is set to <code>False</code>, the API throws an <code>AliasExistsException</code> error if the alias already exists. The default value is <code>False</code>.</p>
pub fn force_alias_creation(mut self, input: bool) -> Self {
self.inner = self.inner.force_alias_creation(input);
self
}
/// <p>This parameter is used only if the <code>phone_number_verified</code> or <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is ignored.</p>
/// <p>If this parameter is set to <code>True</code> and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.</p>
/// <p>If this parameter is set to <code>False</code>, the API throws an <code>AliasExistsException</code> error if the alias already exists. The default value is <code>False</code>.</p>
pub fn set_force_alias_creation(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_force_alias_creation(input);
self
}
/// <p>Set to <code>RESEND</code> to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to <code>SUPPRESS</code> to suppress sending the message. You can specify only one value.</p>
pub fn message_action(mut self, input: crate::model::MessageActionType) -> Self {
self.inner = self.inner.message_action(input);
self
}
/// <p>Set to <code>RESEND</code> to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to <code>SUPPRESS</code> to suppress sending the message. You can specify only one value.</p>
pub fn set_message_action(
mut self,
input: std::option::Option<crate::model::MessageActionType>,
) -> Self {
self.inner = self.inner.set_message_action(input);
self
}
/// Appends an item to `DesiredDeliveryMediums`.
///
/// To override the contents of this collection use [`set_desired_delivery_mediums`](Self::set_desired_delivery_mediums).
///
/// <p>Specify <code>"EMAIL"</code> if email will be used to send the welcome message. Specify <code>"SMS"</code> if the phone number will be used. The default value is <code>"SMS"</code>. You can specify more than one value.</p>
pub fn desired_delivery_mediums(mut self, input: crate::model::DeliveryMediumType) -> Self {
self.inner = self.inner.desired_delivery_mediums(input);
self
}
/// <p>Specify <code>"EMAIL"</code> if email will be used to send the welcome message. Specify <code>"SMS"</code> if the phone number will be used. The default value is <code>"SMS"</code>. You can specify more than one value.</p>
pub fn set_desired_delivery_mediums(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::DeliveryMediumType>>,
) -> Self {
self.inner = self.inner.set_desired_delivery_mediums(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `AdminDeleteUser`.
///
/// <p>Deletes a user as an administrator. Works on any user.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminDeleteUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_delete_user_input::Builder,
}
impl AdminDeleteUser {
/// Creates a new `AdminDeleteUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminDeleteUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminDeleteUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminDeleteUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminDeleteUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to delete the user.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to delete the user.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user you want to delete.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user you want to delete.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
}
/// Fluent builder constructing a request to `AdminDeleteUserAttributes`.
///
/// <p>Deletes the user attributes in a user pool as an administrator. Works on any user.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminDeleteUserAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_delete_user_attributes_input::Builder,
}
impl AdminDeleteUserAttributes {
/// Creates a new `AdminDeleteUserAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminDeleteUserAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminDeleteUserAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminDeleteUserAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::AdminDeleteUserAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to delete user attributes.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to delete user attributes.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user from which you would like to delete attributes.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user from which you would like to delete attributes.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// Appends an item to `UserAttributeNames`.
///
/// To override the contents of this collection use [`set_user_attribute_names`](Self::set_user_attribute_names).
///
/// <p>An array of strings representing the user attribute names you want to delete.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
pub fn user_attribute_names(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_attribute_names(input.into());
self
}
/// <p>An array of strings representing the user attribute names you want to delete.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
pub fn set_user_attribute_names(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_user_attribute_names(input);
self
}
}
/// Fluent builder constructing a request to `AdminDisableProviderForUser`.
///
/// <p>Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked <code>DestinationUser</code>, the user must create a new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
/// <p>This action is enabled only for admin access and requires developer credentials.</p>
/// <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p>
/// <p>To deactivate a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the name that is used in the user pool for the user.</p>
/// <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social IdPs. The <code>ProviderAttributeValue</code> must always be the exact subject that was used when the user was originally linked as a source user.</p>
/// <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code> must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked using <code> AdminLinkProviderForUser</code> call. (If the linking was done with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminDisableProviderForUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_disable_provider_for_user_input::Builder,
}
impl AdminDisableProviderForUser {
/// Creates a new `AdminDisableProviderForUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminDisableProviderForUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminDisableProviderForUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminDisableProviderForUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminDisableProviderForUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user to be disabled.</p>
pub fn user(mut self, input: crate::model::ProviderUserIdentifierType) -> Self {
self.inner = self.inner.user(input);
self
}
/// <p>The user to be disabled.</p>
pub fn set_user(
mut self,
input: std::option::Option<crate::model::ProviderUserIdentifierType>,
) -> Self {
self.inner = self.inner.set_user(input);
self
}
}
/// Fluent builder constructing a request to `AdminDisableUser`.
///
/// <p>Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to <code>GetUser</code> and <code>ListUsers</code> API requests.</p>
/// <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminDisableUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_disable_user_input::Builder,
}
impl AdminDisableUser {
/// Creates a new `AdminDisableUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminDisableUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminDisableUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminDisableUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminDisableUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to disable the user.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to disable the user.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user you want to disable.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user you want to disable.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
}
/// Fluent builder constructing a request to `AdminEnableUser`.
///
/// <p>Enables the specified user as an administrator. Works on any user.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminEnableUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_enable_user_input::Builder,
}
impl AdminEnableUser {
/// Creates a new `AdminEnableUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminEnableUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminEnableUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminEnableUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminEnableUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to enable the user.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to enable the user.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user you want to enable.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user you want to enable.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
}
/// Fluent builder constructing a request to `AdminForgetDevice`.
///
/// <p>Forgets the device, as an administrator.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminForgetDevice {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_forget_device_input::Builder,
}
impl AdminForgetDevice {
/// Creates a new `AdminForgetDevice`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminForgetDevice,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminForgetDeviceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminForgetDeviceOutput,
aws_smithy_http::result::SdkError<crate::error::AdminForgetDeviceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
}
/// Fluent builder constructing a request to `AdminGetDevice`.
///
/// <p>Gets the device, as an administrator.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminGetDevice {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_get_device_input::Builder,
}
impl AdminGetDevice {
/// Creates a new `AdminGetDevice`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminGetDevice,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminGetDeviceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminGetDeviceOutput,
aws_smithy_http::result::SdkError<crate::error::AdminGetDeviceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
}
/// Fluent builder constructing a request to `AdminGetUser`.
///
/// <p>Gets the specified user by user name in a user pool as an administrator. Works on any user.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminGetUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_get_user_input::Builder,
}
impl AdminGetUser {
/// Creates a new `AdminGetUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminGetUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminGetUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminGetUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminGetUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to get information about the user.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to get information about the user.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user you want to retrieve.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user you want to retrieve.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
}
/// Fluent builder constructing a request to `AdminInitiateAuth`.
///
/// <p>Initiates the authentication flow, as an administrator.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminInitiateAuth {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_initiate_auth_input::Builder,
}
impl AdminInitiateAuth {
/// Creates a new `AdminInitiateAuth`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminInitiateAuth,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminInitiateAuthError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminInitiateAuthOutput,
aws_smithy_http::result::SdkError<crate::error::AdminInitiateAuthError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the Amazon Cognito user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The ID of the Amazon Cognito user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The app client ID.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The authentication flow for this call to run. The API action will depend on this value. For example:</p>
/// <ul>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p> </li>
/// <li> <p> <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and <code>SRP_A</code> and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.</p> </li>
/// <li> <p> <code>ADMIN_USER_PASSWORD_AUTH</code> will take in <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or tokens.</p> </li>
/// </ul>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li>
/// <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li>
/// <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.</p> </li>
/// <li> <p> <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication. This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.</p> </li>
/// </ul>
pub fn auth_flow(mut self, input: crate::model::AuthFlowType) -> Self {
self.inner = self.inner.auth_flow(input);
self
}
/// <p>The authentication flow for this call to run. The API action will depend on this value. For example:</p>
/// <ul>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p> </li>
/// <li> <p> <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and <code>SRP_A</code> and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.</p> </li>
/// <li> <p> <code>ADMIN_USER_PASSWORD_AUTH</code> will take in <code>USERNAME</code> and <code>PASSWORD</code> and return the next challenge or tokens.</p> </li>
/// </ul>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li>
/// <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li>
/// <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.</p> </li>
/// <li> <p> <code>ADMIN_USER_PASSWORD_AUTH</code>: Admin-based user password authentication. This replaces the <code>ADMIN_NO_SRP_AUTH</code> authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.</p> </li>
/// </ul>
pub fn set_auth_flow(
mut self,
input: std::option::Option<crate::model::AuthFlowType>,
) -> Self {
self.inner = self.inner.set_auth_flow(input);
self
}
/// Adds a key-value pair to `AuthParameters`.
///
/// To override the contents of this collection use [`set_auth_parameters`](Self::set_auth_parameters).
///
/// <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you're invoking. The required values depend on the value of <code>AuthFlow</code>:</p>
/// <ul>
/// <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>ADMIN_NO_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>PASSWORD</code> (required), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code>. To start the authentication flow with password verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The SRP_A Value)</code>.</p> </li>
/// </ul>
pub fn auth_parameters(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.auth_parameters(k.into(), v.into());
self
}
/// <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you're invoking. The required values depend on the value of <code>AuthFlow</code>:</p>
/// <ul>
/// <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>ADMIN_NO_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>PASSWORD</code> (required), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code>. To start the authentication flow with password verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The SRP_A Value)</code>.</p> </li>
/// </ul>
pub fn set_auth_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_auth_parameters(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p>
/// <ul>
/// <li> <p>Pre signup</p> </li>
/// <li> <p>Pre authentication</p> </li>
/// <li> <p>User migration</p> </li>
/// </ul>
/// <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p>
/// <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
/// <ul>
/// <li> <p>Post authentication</p> </li>
/// <li> <p>Custom message</p> </li>
/// <li> <p>Pre token generation</p> </li>
/// <li> <p>Create auth challenge</p> </li>
/// <li> <p>Define auth challenge</p> </li>
/// <li> <p>Verify auth challenge</p> </li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p>
/// <ul>
/// <li> <p>Pre signup</p> </li>
/// <li> <p>Pre authentication</p> </li>
/// <li> <p>User migration</p> </li>
/// </ul>
/// <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p>
/// <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
/// <ul>
/// <li> <p>Post authentication</p> </li>
/// <li> <p>Custom message</p> </li>
/// <li> <p>Pre token generation</p> </li>
/// <li> <p>Create auth challenge</p> </li>
/// <li> <p>Define auth challenge</p> </li>
/// <li> <p>Verify auth challenge</p> </li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
/// <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminInitiateAuth</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminInitiateAuth</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn context_data(mut self, input: crate::model::ContextDataType) -> Self {
self.inner = self.inner.context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_context_data(
mut self,
input: std::option::Option<crate::model::ContextDataType>,
) -> Self {
self.inner = self.inner.set_context_data(input);
self
}
}
/// Fluent builder constructing a request to `AdminLinkProviderForUser`.
///
/// <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an identity from an external IdP (<code>SourceUser</code>) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. </p>
/// <p> For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.</p> <note>
/// <p>The maximum number of federated identities linked to a user is five.</p>
/// </note> <important>
/// <p>Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.</p>
/// </important>
/// <p>This action is administrative and requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminLinkProviderForUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_link_provider_for_user_input::Builder,
}
impl AdminLinkProviderForUser {
/// Creates a new `AdminLinkProviderForUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminLinkProviderForUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminLinkProviderForUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminLinkProviderForUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminLinkProviderForUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.</p>
/// <p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user, it should be the provider-specific <code>user_id</code>.</p>
/// <p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p>
/// <p>The <code>ProviderName</code> should be set to <code>Cognito</code> for users in Cognito user pools.</p> <important>
/// <p>All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.</p>
/// </important>
pub fn destination_user(mut self, input: crate::model::ProviderUserIdentifierType) -> Self {
self.inner = self.inner.destination_user(input);
self
}
/// <p>The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.</p>
/// <p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user, it should be the provider-specific <code>user_id</code>.</p>
/// <p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p>
/// <p>The <code>ProviderName</code> should be set to <code>Cognito</code> for users in Cognito user pools.</p> <important>
/// <p>All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.</p>
/// </important>
pub fn set_destination_user(
mut self,
input: std::option::Option<crate::model::ProviderUserIdentifierType>,
) -> Self {
self.inner = self.inner.set_destination_user(input);
self
}
/// <p>An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.</p>
/// <p>If the <code>SourceUser</code> is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>. For social IdPs, the <code>ProviderName</code> will be <code>Facebook</code>, <code>Google</code>, or <code>LoginWithAmazon</code>, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for <code>id</code>, <code>sub</code>, and <code>user_id</code>, respectively. The <code>ProviderAttributeValue</code> for the user must be the same value as the <code>id</code>, <code>sub</code>, or <code>user_id</code> value found in the social IdP token.</p>
/// <p></p>
/// <p>For SAML, the <code>ProviderAttributeName</code> can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the <code>ProviderAttributeName</code>. If you set <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.</p>
pub fn source_user(mut self, input: crate::model::ProviderUserIdentifierType) -> Self {
self.inner = self.inner.source_user(input);
self
}
/// <p>An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.</p>
/// <p>If the <code>SourceUser</code> is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>. For social IdPs, the <code>ProviderName</code> will be <code>Facebook</code>, <code>Google</code>, or <code>LoginWithAmazon</code>, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for <code>id</code>, <code>sub</code>, and <code>user_id</code>, respectively. The <code>ProviderAttributeValue</code> for the user must be the same value as the <code>id</code>, <code>sub</code>, or <code>user_id</code> value found in the social IdP token.</p>
/// <p></p>
/// <p>For SAML, the <code>ProviderAttributeName</code> can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the <code>ProviderAttributeName</code>. If you set <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.</p>
pub fn set_source_user(
mut self,
input: std::option::Option<crate::model::ProviderUserIdentifierType>,
) -> Self {
self.inner = self.inner.set_source_user(input);
self
}
}
/// Fluent builder constructing a request to `AdminListDevices`.
///
/// <p>Lists devices, as an administrator.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminListDevices {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_list_devices_input::Builder,
}
impl AdminListDevices {
/// Creates a new `AdminListDevices`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminListDevices,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminListDevicesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminListDevicesOutput,
aws_smithy_http::result::SdkError<crate::error::AdminListDevicesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The limit of the devices request.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The limit of the devices request.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>The pagination token.</p>
pub fn pagination_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.pagination_token(input.into());
self
}
/// <p>The pagination token.</p>
pub fn set_pagination_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_pagination_token(input);
self
}
}
/// Fluent builder constructing a request to `AdminListGroupsForUser`.
///
/// <p>Lists the groups that the user belongs to.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminListGroupsForUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_list_groups_for_user_input::Builder,
}
impl AdminListGroupsForUser {
/// Creates a new `AdminListGroupsForUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminListGroupsForUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminListGroupsForUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminListGroupsForUserOutput,
aws_smithy_http::result::SdkError<crate::error::AdminListGroupsForUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::AdminListGroupsForUserPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::AdminListGroupsForUserPaginator {
crate::paginator::AdminListGroupsForUserPaginator::new(self.handle, self.inner)
}
/// <p>The username for the user.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The username for the user.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The limit of the request to list groups.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The limit of the request to list groups.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `AdminListUserAuthEvents`.
///
/// <p>A history of user activity and any risks detected as part of Amazon Cognito advanced security.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminListUserAuthEvents {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_list_user_auth_events_input::Builder,
}
impl AdminListUserAuthEvents {
/// Creates a new `AdminListUserAuthEvents`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminListUserAuthEvents,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminListUserAuthEventsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminListUserAuthEventsOutput,
aws_smithy_http::result::SdkError<crate::error::AdminListUserAuthEventsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::AdminListUserAuthEventsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::AdminListUserAuthEventsPaginator {
crate::paginator::AdminListUserAuthEventsPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user pool username or an alias.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user pool username or an alias.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The maximum number of authentication events to return. Returns 60 events if you set <code>MaxResults</code> to 0, or if you don't include a <code>MaxResults</code> parameter.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of authentication events to return. Returns 60 events if you set <code>MaxResults</code> to 0, or if you don't include a <code>MaxResults</code> parameter.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>A pagination token.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A pagination token.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `AdminRemoveUserFromGroup`.
///
/// <p>Removes the specified user from the specified group.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminRemoveUserFromGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_remove_user_from_group_input::Builder,
}
impl AdminRemoveUserFromGroup {
/// Creates a new `AdminRemoveUserFromGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminRemoveUserFromGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminRemoveUserFromGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminRemoveUserFromGroupOutput,
aws_smithy_http::result::SdkError<crate::error::AdminRemoveUserFromGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The username for the user.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The username for the user.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The group name.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The group name.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
}
/// Fluent builder constructing a request to `AdminResetUserPassword`.
///
/// <p>Resets the specified user's password in a user pool as an administrator. Works on any user.</p>
/// <p>When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminResetUserPassword {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_reset_user_password_input::Builder,
}
impl AdminResetUserPassword {
/// Creates a new `AdminResetUserPassword`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminResetUserPassword,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminResetUserPasswordError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminResetUserPasswordOutput,
aws_smithy_http::result::SdkError<crate::error::AdminResetUserPasswordError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to reset the user's password.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to reset the user's password.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user whose password you want to reset.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user whose password you want to reset.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `AdminRespondToAuthChallenge`.
///
/// <p>Responds to an authentication challenge, as an administrator.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminRespondToAuthChallenge {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_respond_to_auth_challenge_input::Builder,
}
impl AdminRespondToAuthChallenge {
/// Creates a new `AdminRespondToAuthChallenge`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminRespondToAuthChallenge,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminRespondToAuthChallengeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminRespondToAuthChallengeOutput,
aws_smithy_http::result::SdkError<crate::error::AdminRespondToAuthChallengeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the Amazon Cognito user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The ID of the Amazon Cognito user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The app client ID.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
pub fn challenge_name(mut self, input: crate::model::ChallengeNameType) -> Self {
self.inner = self.inner.challenge_name(input);
self
}
/// <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
pub fn set_challenge_name(
mut self,
input: std::option::Option<crate::model::ChallengeNameType>,
) -> Self {
self.inner = self.inner.set_challenge_name(input);
self
}
/// Adds a key-value pair to `ChallengeResponses`.
///
/// To override the contents of this collection use [`set_challenge_responses`](Self::set_challenge_responses).
///
/// <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p>
/// <ul>
/// <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li>
/// <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> <note>
/// <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when signing in with a remembered device.</p>
/// </note> </li>
/// <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: <code>PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li>
/// <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>AdminInitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren't required by your user pool.</p> <note>
/// <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>AdminRespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
/// </note> </li>
/// <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li>
/// </ul>
/// <p>The value of the <code>USERNAME</code> attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the <code>AdminInitiateAuth</code> response includes the actual username value in the <code>USERNAMEUSER_ID_FOR_SRP</code> attribute. This happens even if you specified an alias in your call to <code>AdminInitiateAuth</code>.</p>
pub fn challenge_responses(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.challenge_responses(k.into(), v.into());
self
}
/// <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p>
/// <ul>
/// <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li>
/// <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> <note>
/// <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when signing in with a remembered device.</p>
/// </note> </li>
/// <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: <code>PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li>
/// <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>AdminInitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren't required by your user pool.</p> <note>
/// <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>AdminRespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
/// </note> </li>
/// <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li>
/// </ul>
/// <p>The value of the <code>USERNAME</code> attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the <code>AdminInitiateAuth</code> response includes the actual username value in the <code>USERNAMEUSER_ID_FOR_SRP</code> attribute. This happens even if you specified an alias in your call to <code>AdminInitiateAuth</code>.</p>
pub fn set_challenge_responses(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_challenge_responses(input);
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
pub fn session(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.session(input.into());
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
pub fn set_session(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_session(input);
self
}
/// <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminRespondToAuthChallenge</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminRespondToAuthChallenge</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn context_data(mut self, input: crate::model::ContextDataType) -> Self {
self.inner = self.inner.context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_context_data(
mut self,
input: std::option::Option<crate::model::ContextDataType>,
) -> Self {
self.inner = self.inner.set_context_data(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers: </p>
/// <ul>
/// <li> <p>pre sign-up</p> </li>
/// <li> <p>custom message</p> </li>
/// <li> <p>post authentication</p> </li>
/// <li> <p>user migration</p> </li>
/// <li> <p>pre token generation</p> </li>
/// <li> <p>define auth challenge</p> </li>
/// <li> <p>create auth challenge</p> </li>
/// <li> <p>verify auth challenge response</p> </li>
/// </ul>
/// <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers: </p>
/// <ul>
/// <li> <p>pre sign-up</p> </li>
/// <li> <p>custom message</p> </li>
/// <li> <p>post authentication</p> </li>
/// <li> <p>user migration</p> </li>
/// <li> <p>pre token generation</p> </li>
/// <li> <p>define auth challenge</p> </li>
/// <li> <p>create auth challenge</p> </li>
/// <li> <p>verify auth challenge response</p> </li>
/// </ul>
/// <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `AdminSetUserMFAPreference`.
///
/// <p>The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminSetUserMFAPreference {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_set_user_mfa_preference_input::Builder,
}
impl AdminSetUserMFAPreference {
/// Creates a new `AdminSetUserMFAPreference`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminSetUserMFAPreference,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminSetUserMFAPreferenceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminSetUserMfaPreferenceOutput,
aws_smithy_http::result::SdkError<crate::error::AdminSetUserMFAPreferenceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The SMS text message MFA settings.</p>
pub fn sms_mfa_settings(mut self, input: crate::model::SmsMfaSettingsType) -> Self {
self.inner = self.inner.sms_mfa_settings(input);
self
}
/// <p>The SMS text message MFA settings.</p>
pub fn set_sms_mfa_settings(
mut self,
input: std::option::Option<crate::model::SmsMfaSettingsType>,
) -> Self {
self.inner = self.inner.set_sms_mfa_settings(input);
self
}
/// <p>The time-based one-time password software token MFA settings.</p>
pub fn software_token_mfa_settings(
mut self,
input: crate::model::SoftwareTokenMfaSettingsType,
) -> Self {
self.inner = self.inner.software_token_mfa_settings(input);
self
}
/// <p>The time-based one-time password software token MFA settings.</p>
pub fn set_software_token_mfa_settings(
mut self,
input: std::option::Option<crate::model::SoftwareTokenMfaSettingsType>,
) -> Self {
self.inner = self.inner.set_software_token_mfa_settings(input);
self
}
/// <p>The user pool username or alias.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user pool username or alias.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `AdminSetUserPassword`.
///
/// <p>Sets the specified user's password in a user pool as an administrator. Works on any user. </p>
/// <p>The password can be temporary or permanent. If it is temporary, the user status enters the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password. </p>
/// <p>Once the user has set a new password, or the password is permanent, the user status is set to <code>Confirmed</code>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminSetUserPassword {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_set_user_password_input::Builder,
}
impl AdminSetUserPassword {
/// Creates a new `AdminSetUserPassword`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminSetUserPassword,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminSetUserPasswordError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminSetUserPasswordOutput,
aws_smithy_http::result::SdkError<crate::error::AdminSetUserPasswordError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to set the user's password.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to set the user's password.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user whose password you want to set.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user whose password you want to set.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The password for the user.</p>
pub fn password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.password(input.into());
self
}
/// <p>The password for the user.</p>
pub fn set_password(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_password(input);
self
}
/// <p> <code>True</code> if the password is permanent, <code>False</code> if it is temporary.</p>
pub fn permanent(mut self, input: bool) -> Self {
self.inner = self.inner.permanent(input);
self
}
/// <p> <code>True</code> if the password is permanent, <code>False</code> if it is temporary.</p>
pub fn set_permanent(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_permanent(input);
self
}
}
/// Fluent builder constructing a request to `AdminSetUserSettings`.
///
/// <p> <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminSetUserSettings {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_set_user_settings_input::Builder,
}
impl AdminSetUserSettings {
/// Creates a new `AdminSetUserSettings`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminSetUserSettings,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminSetUserSettingsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminSetUserSettingsOutput,
aws_smithy_http::result::SdkError<crate::error::AdminSetUserSettingsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the user pool that contains the user whose options you're setting.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The ID of the user pool that contains the user whose options you're setting.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user whose options you're setting.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user whose options you're setting.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// Appends an item to `MFAOptions`.
///
/// To override the contents of this collection use [`set_mfa_options`](Self::set_mfa_options).
///
/// <p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>
pub fn mfa_options(mut self, input: crate::model::MfaOptionType) -> Self {
self.inner = self.inner.mfa_options(input);
self
}
/// <p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>
pub fn set_mfa_options(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::MfaOptionType>>,
) -> Self {
self.inner = self.inner.set_mfa_options(input);
self
}
}
/// Fluent builder constructing a request to `AdminUpdateAuthEventFeedback`.
///
/// <p>Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminUpdateAuthEventFeedback {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_update_auth_event_feedback_input::Builder,
}
impl AdminUpdateAuthEventFeedback {
/// Creates a new `AdminUpdateAuthEventFeedback`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminUpdateAuthEventFeedback,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminUpdateAuthEventFeedbackError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminUpdateAuthEventFeedbackOutput,
aws_smithy_http::result::SdkError<crate::error::AdminUpdateAuthEventFeedbackError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user pool username.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user pool username.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The authentication event ID.</p>
pub fn event_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.event_id(input.into());
self
}
/// <p>The authentication event ID.</p>
pub fn set_event_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_event_id(input);
self
}
/// <p>The authentication event feedback value.</p>
pub fn feedback_value(mut self, input: crate::model::FeedbackValueType) -> Self {
self.inner = self.inner.feedback_value(input);
self
}
/// <p>The authentication event feedback value.</p>
pub fn set_feedback_value(
mut self,
input: std::option::Option<crate::model::FeedbackValueType>,
) -> Self {
self.inner = self.inner.set_feedback_value(input);
self
}
}
/// Fluent builder constructing a request to `AdminUpdateDeviceStatus`.
///
/// <p>Updates the device status as an administrator.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminUpdateDeviceStatus {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_update_device_status_input::Builder,
}
impl AdminUpdateDeviceStatus {
/// Creates a new `AdminUpdateDeviceStatus`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminUpdateDeviceStatus,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminUpdateDeviceStatusError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminUpdateDeviceStatusOutput,
aws_smithy_http::result::SdkError<crate::error::AdminUpdateDeviceStatusError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
/// <p>The status indicating whether a device has been remembered or not.</p>
pub fn device_remembered_status(
mut self,
input: crate::model::DeviceRememberedStatusType,
) -> Self {
self.inner = self.inner.device_remembered_status(input);
self
}
/// <p>The status indicating whether a device has been remembered or not.</p>
pub fn set_device_remembered_status(
mut self,
input: std::option::Option<crate::model::DeviceRememberedStatusType>,
) -> Self {
self.inner = self.inner.set_device_remembered_status(input);
self
}
}
/// Fluent builder constructing a request to `AdminUpdateUserAttributes`.
///
/// <p>Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>In addition to updating user attributes, this API can also be used to mark phone and email as verified.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminUpdateUserAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_update_user_attributes_input::Builder,
}
impl AdminUpdateUserAttributes {
/// Creates a new `AdminUpdateUserAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminUpdateUserAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminUpdateUserAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminUpdateUserAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::AdminUpdateUserAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to update user attributes.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to update user attributes.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name of the user for whom you want to update user attributes.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user for whom you want to update user attributes.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// Appends an item to `UserAttributes`.
///
/// To override the contents of this collection use [`set_user_attributes`](Self::set_user_attributes).
///
/// <p>An array of name-value pairs representing user attributes.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.</p>
/// <p>To update the value of an attribute that requires verification in the same API request, include the <code>email_verified</code> or <code>phone_number_verified</code> attribute, with a value of <code>true</code>. If you set the <code>email_verified</code> or <code>phone_number_verified</code> value for an <code>email</code> or <code>phone_number</code> attribute that requires verification to <code>true</code>, Amazon Cognito doesn’t send a verification message to your user.</p>
pub fn user_attributes(mut self, input: crate::model::AttributeType) -> Self {
self.inner = self.inner.user_attributes(input);
self
}
/// <p>An array of name-value pairs representing user attributes.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.</p>
/// <p>To update the value of an attribute that requires verification in the same API request, include the <code>email_verified</code> or <code>phone_number_verified</code> attribute, with a value of <code>true</code>. If you set the <code>email_verified</code> or <code>phone_number_verified</code> value for an <code>email</code> or <code>phone_number</code> attribute that requires verification to <code>true</code>, Amazon Cognito doesn’t send a verification message to your user.</p>
pub fn set_user_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AttributeType>>,
) -> Self {
self.inner = self.inner.set_user_attributes(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `AdminUserGlobalSignOut`.
///
/// <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AdminUserGlobalSignOut {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::admin_user_global_sign_out_input::Builder,
}
impl AdminUserGlobalSignOut {
/// Creates a new `AdminUserGlobalSignOut`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AdminUserGlobalSignOut,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AdminUserGlobalSignOutError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AdminUserGlobalSignOutOutput,
aws_smithy_http::result::SdkError<crate::error::AdminUserGlobalSignOutError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user name.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
}
/// Fluent builder constructing a request to `AssociateSoftwareToken`.
///
/// <p>Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an <code>AssociateSoftwareToken</code> request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.</p> <note>
/// <p>Amazon Cognito disassociates an existing software token when you verify the new token in a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge each time your user signs. Complete setup with <code>AssociateSoftwareToken</code> and <code>VerifySoftwareToken</code>.</p>
/// <p>After you set up software token MFA for your user, Amazon Cognito generates a <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to this challenge with your user's TOTP.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AssociateSoftwareToken {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::associate_software_token_input::Builder,
}
impl AssociateSoftwareToken {
/// Creates a new `AssociateSoftwareToken`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AssociateSoftwareToken,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AssociateSoftwareTokenError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AssociateSoftwareTokenOutput,
aws_smithy_http::result::SdkError<crate::error::AssociateSoftwareTokenError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose software token you want to generate.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose software token you want to generate.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.</p>
pub fn session(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.session(input.into());
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.</p>
pub fn set_session(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_session(input);
self
}
}
/// Fluent builder constructing a request to `ChangePassword`.
///
/// <p>Changes the password for a specified user in a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ChangePassword {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::change_password_input::Builder,
}
impl ChangePassword {
/// Creates a new `ChangePassword`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ChangePassword,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ChangePasswordError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ChangePasswordOutput,
aws_smithy_http::result::SdkError<crate::error::ChangePasswordError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The old password.</p>
pub fn previous_password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.previous_password(input.into());
self
}
/// <p>The old password.</p>
pub fn set_previous_password(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_previous_password(input);
self
}
/// <p>The new password.</p>
pub fn proposed_password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.proposed_password(input.into());
self
}
/// <p>The new password.</p>
pub fn set_proposed_password(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_proposed_password(input);
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose password you want to change.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose password you want to change.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `ConfirmDevice`.
///
/// <p>Confirms tracking of the device. This API call is the call that begins device tracking.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ConfirmDevice {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::confirm_device_input::Builder,
}
impl ConfirmDevice {
/// Creates a new `ConfirmDevice`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ConfirmDevice,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ConfirmDeviceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ConfirmDeviceOutput,
aws_smithy_http::result::SdkError<crate::error::ConfirmDeviceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose device you want to confirm.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose device you want to confirm.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
/// <p>The configuration of the device secret verifier.</p>
pub fn device_secret_verifier_config(
mut self,
input: crate::model::DeviceSecretVerifierConfigType,
) -> Self {
self.inner = self.inner.device_secret_verifier_config(input);
self
}
/// <p>The configuration of the device secret verifier.</p>
pub fn set_device_secret_verifier_config(
mut self,
input: std::option::Option<crate::model::DeviceSecretVerifierConfigType>,
) -> Self {
self.inner = self.inner.set_device_secret_verifier_config(input);
self
}
/// <p>The device name.</p>
pub fn device_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_name(input.into());
self
}
/// <p>The device name.</p>
pub fn set_device_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_name(input);
self
}
}
/// Fluent builder constructing a request to `ConfirmForgotPassword`.
///
/// <p>Allows a user to enter a confirmation code to reset a forgotten password.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ConfirmForgotPassword {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::confirm_forgot_password_input::Builder,
}
impl ConfirmForgotPassword {
/// Creates a new `ConfirmForgotPassword`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ConfirmForgotPassword,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ConfirmForgotPasswordError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ConfirmForgotPasswordOutput,
aws_smithy_http::result::SdkError<crate::error::ConfirmForgotPasswordError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The app client ID of the app associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID of the app associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn secret_hash(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_hash(input.into());
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn set_secret_hash(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_hash(input);
self
}
/// <p>The user name of the user for whom you want to enter a code to retrieve a forgotten password.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user for whom you want to enter a code to retrieve a forgotten password.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The confirmation code from your user's request to reset their password. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
pub fn confirmation_code(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.confirmation_code(input.into());
self
}
/// <p>The confirmation code from your user's request to reset their password. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
pub fn set_confirmation_code(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_confirmation_code(input);
self
}
/// <p>The new password that your user wants to set.</p>
pub fn password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.password(input.into());
self
}
/// <p>The new password that your user wants to set.</p>
pub fn set_password(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_password(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmForgotPassword</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmForgotPassword</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `ConfirmSignUp`.
///
/// <p>Confirms registration of a new user.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ConfirmSignUp {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::confirm_sign_up_input::Builder,
}
impl ConfirmSignUp {
/// Creates a new `ConfirmSignUp`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ConfirmSignUp,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ConfirmSignUpError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ConfirmSignUpOutput,
aws_smithy_http::result::SdkError<crate::error::ConfirmSignUpError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the app client associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The ID of the app client associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn secret_hash(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_hash(input.into());
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn set_secret_hash(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_hash(input);
self
}
/// <p>The user name of the user whose registration you want to confirm.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user whose registration you want to confirm.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The confirmation code sent by a user's request to confirm registration.</p>
pub fn confirmation_code(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.confirmation_code(input.into());
self
}
/// <p>The confirmation code sent by a user's request to confirm registration.</p>
pub fn set_confirmation_code(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_confirmation_code(input);
self
}
/// <p>Boolean to be specified to force user confirmation irrespective of existing alias. By default set to <code>False</code>. If this parameter is set to <code>True</code> and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to <code>False</code>, the API will throw an <b>AliasExistsException</b> error.</p>
pub fn force_alias_creation(mut self, input: bool) -> Self {
self.inner = self.inner.force_alias_creation(input);
self
}
/// <p>Boolean to be specified to force user confirmation irrespective of existing alias. By default set to <code>False</code>. If this parameter is set to <code>True</code> and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to <code>False</code>, the API will throw an <b>AliasExistsException</b> error.</p>
pub fn set_force_alias_creation(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_force_alias_creation(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmSignUp</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmSignUp</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `CreateGroup`.
///
/// <p>Creates a new group in the specified user pool.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_group_input::Builder,
}
impl CreateGroup {
/// Creates a new `CreateGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateGroupOutput,
aws_smithy_http::result::SdkError<crate::error::CreateGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the group. Must be unique.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The name of the group. Must be unique.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>A string containing the description of the group.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A string containing the description of the group.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_arn(input.into());
self
}
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_arn(input);
self
}
/// <p>A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub fn precedence(mut self, input: i32) -> Self {
self.inner = self.inner.precedence(input);
self
}
/// <p>A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub fn set_precedence(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_precedence(input);
self
}
}
/// Fluent builder constructing a request to `CreateIdentityProvider`.
///
/// <p>Creates an IdP for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateIdentityProvider {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_identity_provider_input::Builder,
}
impl CreateIdentityProvider {
/// Creates a new `CreateIdentityProvider`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateIdentityProvider,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateIdentityProviderError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateIdentityProviderOutput,
aws_smithy_http::result::SdkError<crate::error::CreateIdentityProviderError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The IdP name.</p>
pub fn provider_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.provider_name(input.into());
self
}
/// <p>The IdP name.</p>
pub fn set_provider_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_provider_name(input);
self
}
/// <p>The IdP type.</p>
pub fn provider_type(mut self, input: crate::model::IdentityProviderTypeType) -> Self {
self.inner = self.inner.provider_type(input);
self
}
/// <p>The IdP type.</p>
pub fn set_provider_type(
mut self,
input: std::option::Option<crate::model::IdentityProviderTypeType>,
) -> Self {
self.inner = self.inner.set_provider_type(input);
self
}
/// Adds a key-value pair to `ProviderDetails`.
///
/// To override the contents of this collection use [`set_provider_details`](Self::set_provider_details).
///
/// <p>The IdP details. The following list describes the provider detail keys for each IdP type.</p>
/// <ul>
/// <li> <p>For Google and Login with Amazon:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>client_secret</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// </ul> </li>
/// <li> <p>For Facebook:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>client_secret</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// <li> <p>api_version</p> </li>
/// </ul> </li>
/// <li> <p>For Sign in with Apple:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>team_id</p> </li>
/// <li> <p>key_id</p> </li>
/// <li> <p>private_key</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// </ul> </li>
/// <li> <p>For OpenID Connect (OIDC) providers:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>client_secret</p> </li>
/// <li> <p>attributes_request_method</p> </li>
/// <li> <p>oidc_issuer</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// <li> <p>The following keys are only present if Amazon Cognito didn't discover them at the <code>oidc_issuer</code> URL.</p>
/// <ul>
/// <li> <p>authorize_url </p> </li>
/// <li> <p>token_url </p> </li>
/// <li> <p>attributes_url </p> </li>
/// <li> <p>jwks_uri </p> </li>
/// </ul> </li>
/// <li> <p>Amazon Cognito sets the value of the following keys automatically. They are read-only.</p>
/// <ul>
/// <li> <p>attributes_url_add_attributes </p> </li>
/// </ul> </li>
/// </ul> </li>
/// <li> <p>For SAML providers:</p>
/// <ul>
/// <li> <p>MetadataFile or MetadataURL</p> </li>
/// <li> <p>IDPSignout <i>optional</i> </p> </li>
/// </ul> </li>
/// </ul>
pub fn provider_details(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.provider_details(k.into(), v.into());
self
}
/// <p>The IdP details. The following list describes the provider detail keys for each IdP type.</p>
/// <ul>
/// <li> <p>For Google and Login with Amazon:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>client_secret</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// </ul> </li>
/// <li> <p>For Facebook:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>client_secret</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// <li> <p>api_version</p> </li>
/// </ul> </li>
/// <li> <p>For Sign in with Apple:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>team_id</p> </li>
/// <li> <p>key_id</p> </li>
/// <li> <p>private_key</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// </ul> </li>
/// <li> <p>For OpenID Connect (OIDC) providers:</p>
/// <ul>
/// <li> <p>client_id</p> </li>
/// <li> <p>client_secret</p> </li>
/// <li> <p>attributes_request_method</p> </li>
/// <li> <p>oidc_issuer</p> </li>
/// <li> <p>authorize_scopes</p> </li>
/// <li> <p>The following keys are only present if Amazon Cognito didn't discover them at the <code>oidc_issuer</code> URL.</p>
/// <ul>
/// <li> <p>authorize_url </p> </li>
/// <li> <p>token_url </p> </li>
/// <li> <p>attributes_url </p> </li>
/// <li> <p>jwks_uri </p> </li>
/// </ul> </li>
/// <li> <p>Amazon Cognito sets the value of the following keys automatically. They are read-only.</p>
/// <ul>
/// <li> <p>attributes_url_add_attributes </p> </li>
/// </ul> </li>
/// </ul> </li>
/// <li> <p>For SAML providers:</p>
/// <ul>
/// <li> <p>MetadataFile or MetadataURL</p> </li>
/// <li> <p>IDPSignout <i>optional</i> </p> </li>
/// </ul> </li>
/// </ul>
pub fn set_provider_details(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_provider_details(input);
self
}
/// Adds a key-value pair to `AttributeMapping`.
///
/// To override the contents of this collection use [`set_attribute_mapping`](Self::set_attribute_mapping).
///
/// <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
pub fn attribute_mapping(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attribute_mapping(k.into(), v.into());
self
}
/// <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
pub fn set_attribute_mapping(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attribute_mapping(input);
self
}
/// Appends an item to `IdpIdentifiers`.
///
/// To override the contents of this collection use [`set_idp_identifiers`](Self::set_idp_identifiers).
///
/// <p>A list of IdP identifiers.</p>
pub fn idp_identifiers(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.idp_identifiers(input.into());
self
}
/// <p>A list of IdP identifiers.</p>
pub fn set_idp_identifiers(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_idp_identifiers(input);
self
}
}
/// Fluent builder constructing a request to `CreateResourceServer`.
///
/// <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateResourceServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_resource_server_input::Builder,
}
impl CreateResourceServer {
/// Creates a new `CreateResourceServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateResourceServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateResourceServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateResourceServerOutput,
aws_smithy_http::result::SdkError<crate::error::CreateResourceServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as <code>https://my-weather-api.example.com</code>.</p>
pub fn identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.identifier(input.into());
self
}
/// <p>A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as <code>https://my-weather-api.example.com</code>.</p>
pub fn set_identifier(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_identifier(input);
self
}
/// <p>A friendly name for the resource server.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A friendly name for the resource server.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// Appends an item to `Scopes`.
///
/// To override the contents of this collection use [`set_scopes`](Self::set_scopes).
///
/// <p>A list of scopes. Each scope is a key-value map with the keys <code>name</code> and <code>description</code>.</p>
pub fn scopes(mut self, input: crate::model::ResourceServerScopeType) -> Self {
self.inner = self.inner.scopes(input);
self
}
/// <p>A list of scopes. Each scope is a key-value map with the keys <code>name</code> and <code>description</code>.</p>
pub fn set_scopes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::ResourceServerScopeType>>,
) -> Self {
self.inner = self.inner.set_scopes(input);
self
}
}
/// Fluent builder constructing a request to `CreateUserImportJob`.
///
/// <p>Creates the user import job.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateUserImportJob {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_user_import_job_input::Builder,
}
impl CreateUserImportJob {
/// Creates a new `CreateUserImportJob`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateUserImportJob,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateUserImportJobError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateUserImportJobOutput,
aws_smithy_http::result::SdkError<crate::error::CreateUserImportJobError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The job name for the user import job.</p>
pub fn job_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.job_name(input.into());
self
}
/// <p>The job name for the user import job.</p>
pub fn set_job_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_job_name(input);
self
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.</p>
pub fn cloud_watch_logs_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cloud_watch_logs_role_arn(input.into());
self
}
/// <p>The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.</p>
pub fn set_cloud_watch_logs_role_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cloud_watch_logs_role_arn(input);
self
}
}
/// Fluent builder constructing a request to `CreateUserPool`.
///
/// <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateUserPool {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_user_pool_input::Builder,
}
impl CreateUserPool {
/// Creates a new `CreateUserPool`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateUserPool,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateUserPoolError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateUserPoolOutput,
aws_smithy_http::result::SdkError<crate::error::CreateUserPoolError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A string used to name the user pool.</p>
pub fn pool_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.pool_name(input.into());
self
}
/// <p>A string used to name the user pool.</p>
pub fn set_pool_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_pool_name(input);
self
}
/// <p>The policies associated with the new user pool.</p>
pub fn policies(mut self, input: crate::model::UserPoolPolicyType) -> Self {
self.inner = self.inner.policies(input);
self
}
/// <p>The policies associated with the new user pool.</p>
pub fn set_policies(
mut self,
input: std::option::Option<crate::model::UserPoolPolicyType>,
) -> Self {
self.inner = self.inner.set_policies(input);
self
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn deletion_protection(mut self, input: crate::model::DeletionProtectionType) -> Self {
self.inner = self.inner.deletion_protection(input);
self
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn set_deletion_protection(
mut self,
input: std::option::Option<crate::model::DeletionProtectionType>,
) -> Self {
self.inner = self.inner.set_deletion_protection(input);
self
}
/// <p>The Lambda trigger configuration information for the new user pool.</p> <note>
/// <p>In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.</p>
/// <p></p>
/// <p>For more information on using the Lambda API to add permission, see<a href="https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html"> AddPermission </a>. </p>
/// <p>For adding permission using the CLI, see<a href="https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html"> add-permission </a>.</p>
/// </note>
pub fn lambda_config(mut self, input: crate::model::LambdaConfigType) -> Self {
self.inner = self.inner.lambda_config(input);
self
}
/// <p>The Lambda trigger configuration information for the new user pool.</p> <note>
/// <p>In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.</p>
/// <p></p>
/// <p>For more information on using the Lambda API to add permission, see<a href="https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html"> AddPermission </a>. </p>
/// <p>For adding permission using the CLI, see<a href="https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html"> add-permission </a>.</p>
/// </note>
pub fn set_lambda_config(
mut self,
input: std::option::Option<crate::model::LambdaConfigType>,
) -> Self {
self.inner = self.inner.set_lambda_config(input);
self
}
/// Appends an item to `AutoVerifiedAttributes`.
///
/// To override the contents of this collection use [`set_auto_verified_attributes`](Self::set_auto_verified_attributes).
///
/// <p>The attributes to be auto-verified. Possible values: <b>email</b>, <b>phone_number</b>.</p>
pub fn auto_verified_attributes(
mut self,
input: crate::model::VerifiedAttributeType,
) -> Self {
self.inner = self.inner.auto_verified_attributes(input);
self
}
/// <p>The attributes to be auto-verified. Possible values: <b>email</b>, <b>phone_number</b>.</p>
pub fn set_auto_verified_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::VerifiedAttributeType>>,
) -> Self {
self.inner = self.inner.set_auto_verified_attributes(input);
self
}
/// Appends an item to `AliasAttributes`.
///
/// To override the contents of this collection use [`set_alias_attributes`](Self::set_alias_attributes).
///
/// <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or <b>preferred_username</b>.</p>
pub fn alias_attributes(mut self, input: crate::model::AliasAttributeType) -> Self {
self.inner = self.inner.alias_attributes(input);
self
}
/// <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or <b>preferred_username</b>.</p>
pub fn set_alias_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AliasAttributeType>>,
) -> Self {
self.inner = self.inner.set_alias_attributes(input);
self
}
/// Appends an item to `UsernameAttributes`.
///
/// To override the contents of this collection use [`set_username_attributes`](Self::set_username_attributes).
///
/// <p>Specifies whether a user can use an email address or phone number as a username when they sign up.</p>
pub fn username_attributes(mut self, input: crate::model::UsernameAttributeType) -> Self {
self.inner = self.inner.username_attributes(input);
self
}
/// <p>Specifies whether a user can use an email address or phone number as a username when they sign up.</p>
pub fn set_username_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::UsernameAttributeType>>,
) -> Self {
self.inner = self.inner.set_username_attributes(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn sms_verification_message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sms_verification_message(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_sms_verification_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_sms_verification_message(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn email_verification_message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.email_verification_message(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_email_verification_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_email_verification_message(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn email_verification_subject(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.email_verification_subject(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_email_verification_subject(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_email_verification_subject(input);
self
}
/// <p>The template for the verification message that the user sees when the app requests permission to access the user's information.</p>
pub fn verification_message_template(
mut self,
input: crate::model::VerificationMessageTemplateType,
) -> Self {
self.inner = self.inner.verification_message_template(input);
self
}
/// <p>The template for the verification message that the user sees when the app requests permission to access the user's information.</p>
pub fn set_verification_message_template(
mut self,
input: std::option::Option<crate::model::VerificationMessageTemplateType>,
) -> Self {
self.inner = self.inner.set_verification_message_template(input);
self
}
/// <p>A string representing the SMS authentication message.</p>
pub fn sms_authentication_message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sms_authentication_message(input.into());
self
}
/// <p>A string representing the SMS authentication message.</p>
pub fn set_sms_authentication_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_sms_authentication_message(input);
self
}
/// <p>Specifies MFA configuration details.</p>
pub fn mfa_configuration(mut self, input: crate::model::UserPoolMfaType) -> Self {
self.inner = self.inner.mfa_configuration(input);
self
}
/// <p>Specifies MFA configuration details.</p>
pub fn set_mfa_configuration(
mut self,
input: std::option::Option<crate::model::UserPoolMfaType>,
) -> Self {
self.inner = self.inner.set_mfa_configuration(input);
self
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn user_attribute_update_settings(
mut self,
input: crate::model::UserAttributeUpdateSettingsType,
) -> Self {
self.inner = self.inner.user_attribute_update_settings(input);
self
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn set_user_attribute_update_settings(
mut self,
input: std::option::Option<crate::model::UserAttributeUpdateSettingsType>,
) -> Self {
self.inner = self.inner.set_user_attribute_update_settings(input);
self
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn device_configuration(
mut self,
input: crate::model::DeviceConfigurationType,
) -> Self {
self.inner = self.inner.device_configuration(input);
self
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn set_device_configuration(
mut self,
input: std::option::Option<crate::model::DeviceConfigurationType>,
) -> Self {
self.inner = self.inner.set_device_configuration(input);
self
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.</p>
pub fn email_configuration(mut self, input: crate::model::EmailConfigurationType) -> Self {
self.inner = self.inner.email_configuration(input);
self
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.</p>
pub fn set_email_configuration(
mut self,
input: std::option::Option<crate::model::EmailConfigurationType>,
) -> Self {
self.inner = self.inner.set_email_configuration(input);
self
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn sms_configuration(mut self, input: crate::model::SmsConfigurationType) -> Self {
self.inner = self.inner.sms_configuration(input);
self
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn set_sms_configuration(
mut self,
input: std::option::Option<crate::model::SmsConfigurationType>,
) -> Self {
self.inner = self.inner.set_sms_configuration(input);
self
}
/// Adds a key-value pair to `UserPoolTags`.
///
/// To override the contents of this collection use [`set_user_pool_tags`](Self::set_user_pool_tags).
///
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn user_pool_tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.user_pool_tags(k.into(), v.into());
self
}
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn set_user_pool_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_user_pool_tags(input);
self
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn admin_create_user_config(
mut self,
input: crate::model::AdminCreateUserConfigType,
) -> Self {
self.inner = self.inner.admin_create_user_config(input);
self
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn set_admin_create_user_config(
mut self,
input: std::option::Option<crate::model::AdminCreateUserConfigType>,
) -> Self {
self.inner = self.inner.set_admin_create_user_config(input);
self
}
/// Appends an item to `Schema`.
///
/// To override the contents of this collection use [`set_schema`](Self::set_schema).
///
/// <p>An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.</p>
pub fn schema(mut self, input: crate::model::SchemaAttributeType) -> Self {
self.inner = self.inner.schema(input);
self
}
/// <p>An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.</p>
pub fn set_schema(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::SchemaAttributeType>>,
) -> Self {
self.inner = self.inner.set_schema(input);
self
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn user_pool_add_ons(mut self, input: crate::model::UserPoolAddOnsType) -> Self {
self.inner = self.inner.user_pool_add_ons(input);
self
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn set_user_pool_add_ons(
mut self,
input: std::option::Option<crate::model::UserPoolAddOnsType>,
) -> Self {
self.inner = self.inner.set_user_pool_add_ons(input);
self
}
/// <p>Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to <code>False</code>, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
pub fn username_configuration(
mut self,
input: crate::model::UsernameConfigurationType,
) -> Self {
self.inner = self.inner.username_configuration(input);
self
}
/// <p>Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to <code>False</code>, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
pub fn set_username_configuration(
mut self,
input: std::option::Option<crate::model::UsernameConfigurationType>,
) -> Self {
self.inner = self.inner.set_username_configuration(input);
self
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn account_recovery_setting(
mut self,
input: crate::model::AccountRecoverySettingType,
) -> Self {
self.inner = self.inner.account_recovery_setting(input);
self
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn set_account_recovery_setting(
mut self,
input: std::option::Option<crate::model::AccountRecoverySettingType>,
) -> Self {
self.inner = self.inner.set_account_recovery_setting(input);
self
}
}
/// Fluent builder constructing a request to `CreateUserPoolClient`.
///
/// <p>Creates the user pool client.</p>
/// <p>When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateUserPoolClient {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_user_pool_client_input::Builder,
}
impl CreateUserPoolClient {
/// Creates a new `CreateUserPoolClient`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateUserPoolClient,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateUserPoolClientError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateUserPoolClientOutput,
aws_smithy_http::result::SdkError<crate::error::CreateUserPoolClientError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to create a user pool client.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to create a user pool client.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The client name for the user pool client you would like to create.</p>
pub fn client_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_name(input.into());
self
}
/// <p>The client name for the user pool client you would like to create.</p>
pub fn set_client_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_name(input);
self
}
/// <p>Boolean to specify whether you want to generate a secret for the user pool client being created.</p>
pub fn generate_secret(mut self, input: bool) -> Self {
self.inner = self.inner.generate_secret(input);
self
}
/// <p>Boolean to specify whether you want to generate a secret for the user pool client being created.</p>
pub fn set_generate_secret(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_generate_secret(input);
self
}
/// <p>The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session and retrieve new access and ID tokens for 10 days.</p>
/// <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days. You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.</p>
pub fn refresh_token_validity(mut self, input: i32) -> Self {
self.inner = self.inner.refresh_token_validity(input);
self
}
/// <p>The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session and retrieve new access and ID tokens for 10 days.</p>
/// <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days. You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.</p>
pub fn set_refresh_token_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_refresh_token_validity(input);
self
}
/// <p>The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for <code>AccessTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with their access token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.</p>
pub fn access_token_validity(mut self, input: i32) -> Self {
self.inner = self.inner.access_token_validity(input);
self
}
/// <p>The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for <code>AccessTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with their access token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.</p>
pub fn set_access_token_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_access_token_validity(input);
self
}
/// <p>The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for <code>IdTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their session with their ID token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.</p>
pub fn id_token_validity(mut self, input: i32) -> Self {
self.inner = self.inner.id_token_validity(input);
self
}
/// <p>The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for <code>IdTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their session with their ID token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.</p>
pub fn set_id_token_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_id_token_validity(input);
self
}
/// <p>The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.</p>
pub fn token_validity_units(mut self, input: crate::model::TokenValidityUnitsType) -> Self {
self.inner = self.inner.token_validity_units(input);
self
}
/// <p>The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.</p>
pub fn set_token_validity_units(
mut self,
input: std::option::Option<crate::model::TokenValidityUnitsType>,
) -> Self {
self.inner = self.inner.set_token_validity_units(input);
self
}
/// Appends an item to `ReadAttributes`.
///
/// To override the contents of this collection use [`set_read_attributes`](Self::set_read_attributes).
///
/// <p>The read attributes.</p>
pub fn read_attributes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.read_attributes(input.into());
self
}
/// <p>The read attributes.</p>
pub fn set_read_attributes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_read_attributes(input);
self
}
/// Appends an item to `WriteAttributes`.
///
/// To override the contents of this collection use [`set_write_attributes`](Self::set_write_attributes).
///
/// <p>The user pool attributes that the app client can write to.</p>
/// <p>If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user pool</a>.</p>
pub fn write_attributes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.write_attributes(input.into());
self
}
/// <p>The user pool attributes that the app client can write to.</p>
/// <p>If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user pool</a>.</p>
pub fn set_write_attributes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_write_attributes(input);
self
}
/// Appends an item to `ExplicitAuthFlows`.
///
/// To override the contents of this collection use [`set_explicit_auth_flows`](Self::set_explicit_auth_flows).
///
/// <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.</p> <note>
/// <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p>
/// </note>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.</p> </li>
/// <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li>
/// <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li>
/// <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li>
/// <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li>
/// </ul>
/// <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>. You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>, like <code>ALLOW_USER_SRP_AUTH</code>.</p>
pub fn explicit_auth_flows(mut self, input: crate::model::ExplicitAuthFlowsType) -> Self {
self.inner = self.inner.explicit_auth_flows(input);
self
}
/// <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.</p> <note>
/// <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p>
/// </note>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.</p> </li>
/// <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li>
/// <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li>
/// <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li>
/// <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li>
/// </ul>
/// <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>. You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>, like <code>ALLOW_USER_SRP_AUTH</code>.</p>
pub fn set_explicit_auth_flows(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::ExplicitAuthFlowsType>>,
) -> Self {
self.inner = self.inner.set_explicit_auth_flows(input);
self
}
/// Appends an item to `SupportedIdentityProviders`.
///
/// To override the contents of this collection use [`set_supported_identity_providers`](Self::set_supported_identity_providers).
///
/// <p>A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
pub fn supported_identity_providers(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.supported_identity_providers(input.into());
self
}
/// <p>A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
pub fn set_supported_identity_providers(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_supported_identity_providers(input);
self
}
/// Appends an item to `CallbackURLs`.
///
/// To override the contents of this collection use [`set_callback_ur_ls`](Self::set_callback_ur_ls).
///
/// <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
/// <p>App callback URLs such as myapp://example are also supported.</p>
pub fn callback_ur_ls(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.callback_ur_ls(input.into());
self
}
/// <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
/// <p>App callback URLs such as myapp://example are also supported.</p>
pub fn set_callback_ur_ls(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_callback_ur_ls(input);
self
}
/// Appends an item to `LogoutURLs`.
///
/// To override the contents of this collection use [`set_logout_ur_ls`](Self::set_logout_ur_ls).
///
/// <p>A list of allowed logout URLs for the IdPs.</p>
pub fn logout_ur_ls(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.logout_ur_ls(input.into());
self
}
/// <p>A list of allowed logout URLs for the IdPs.</p>
pub fn set_logout_ur_ls(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_logout_ur_ls(input);
self
}
/// <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
/// <p>App callback URLs such as myapp://example are also supported.</p>
pub fn default_redirect_uri(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.default_redirect_uri(input.into());
self
}
/// <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
/// <p>App callback URLs such as myapp://example are also supported.</p>
pub fn set_default_redirect_uri(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_default_redirect_uri(input);
self
}
/// Appends an item to `AllowedOAuthFlows`.
///
/// To override the contents of this collection use [`set_allowed_o_auth_flows`](Self::set_allowed_o_auth_flows).
///
/// <p>The allowed OAuth flows.</p>
/// <dl>
/// <dt>
/// code
/// </dt>
/// <dd>
/// <p>Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the <code>/oauth2/token</code> endpoint.</p>
/// </dd>
/// <dt>
/// implicit
/// </dt>
/// <dd>
/// <p>Issue the access token (and, optionally, ID token, based on scopes) directly to your user.</p>
/// </dd>
/// <dt>
/// client_credentials
/// </dt>
/// <dd>
/// <p>Issue the access token from the <code>/oauth2/token</code> endpoint directly to a non-person user using a combination of the client ID and client secret.</p>
/// </dd>
/// </dl>
pub fn allowed_o_auth_flows(mut self, input: crate::model::OAuthFlowType) -> Self {
self.inner = self.inner.allowed_o_auth_flows(input);
self
}
/// <p>The allowed OAuth flows.</p>
/// <dl>
/// <dt>
/// code
/// </dt>
/// <dd>
/// <p>Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the <code>/oauth2/token</code> endpoint.</p>
/// </dd>
/// <dt>
/// implicit
/// </dt>
/// <dd>
/// <p>Issue the access token (and, optionally, ID token, based on scopes) directly to your user.</p>
/// </dd>
/// <dt>
/// client_credentials
/// </dt>
/// <dd>
/// <p>Issue the access token from the <code>/oauth2/token</code> endpoint directly to a non-person user using a combination of the client ID and client secret.</p>
/// </dd>
/// </dl>
pub fn set_allowed_o_auth_flows(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::OAuthFlowType>>,
) -> Self {
self.inner = self.inner.set_allowed_o_auth_flows(input);
self
}
/// Appends an item to `AllowedOAuthScopes`.
///
/// To override the contents of this collection use [`set_allowed_o_auth_scopes`](Self::set_allowed_o_auth_scopes).
///
/// <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>
pub fn allowed_o_auth_scopes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.allowed_o_auth_scopes(input.into());
self
}
/// <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>
pub fn set_allowed_o_auth_scopes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_allowed_o_auth_scopes(input);
self
}
/// <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
pub fn allowed_o_auth_flows_user_pool_client(mut self, input: bool) -> Self {
self.inner = self.inner.allowed_o_auth_flows_user_pool_client(input);
self
}
/// <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
pub fn set_allowed_o_auth_flows_user_pool_client(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.inner = self.inner.set_allowed_o_auth_flows_user_pool_client(input);
self
}
/// <p>The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.</p> <note>
/// <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p>
/// </note>
pub fn analytics_configuration(
mut self,
input: crate::model::AnalyticsConfigurationType,
) -> Self {
self.inner = self.inner.analytics_configuration(input);
self
}
/// <p>The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.</p> <note>
/// <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p>
/// </note>
pub fn set_analytics_configuration(
mut self,
input: std::option::Option<crate::model::AnalyticsConfigurationType>,
) -> Self {
self.inner = self.inner.set_analytics_configuration(input);
self
}
/// <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li>
/// <li> <p> <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.</p> </li>
/// </ul>
pub fn prevent_user_existence_errors(
mut self,
input: crate::model::PreventUserExistenceErrorTypes,
) -> Self {
self.inner = self.inner.prevent_user_existence_errors(input);
self
}
/// <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li>
/// <li> <p> <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.</p> </li>
/// </ul>
pub fn set_prevent_user_existence_errors(
mut self,
input: std::option::Option<crate::model::PreventUserExistenceErrorTypes>,
) -> Self {
self.inner = self.inner.set_prevent_user_existence_errors(input);
self
}
/// <p>Activates or deactivates token revocation. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
/// <p>If you don't include this parameter, token revocation is automatically activated for the new user pool client.</p>
pub fn enable_token_revocation(mut self, input: bool) -> Self {
self.inner = self.inner.enable_token_revocation(input);
self
}
/// <p>Activates or deactivates token revocation. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
/// <p>If you don't include this parameter, token revocation is automatically activated for the new user pool client.</p>
pub fn set_enable_token_revocation(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_enable_token_revocation(input);
self
}
/// <p>Activates the propagation of additional user context data. For more information about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a client secret.</p>
pub fn enable_propagate_additional_user_context_data(mut self, input: bool) -> Self {
self.inner = self
.inner
.enable_propagate_additional_user_context_data(input);
self
}
/// <p>Activates the propagation of additional user context data. For more information about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a client secret.</p>
pub fn set_enable_propagate_additional_user_context_data(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.inner = self
.inner
.set_enable_propagate_additional_user_context_data(input);
self
}
/// <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
pub fn auth_session_validity(mut self, input: i32) -> Self {
self.inner = self.inner.auth_session_validity(input);
self
}
/// <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
pub fn set_auth_session_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_auth_session_validity(input);
self
}
}
/// Fluent builder constructing a request to `CreateUserPoolDomain`.
///
/// <p>Creates a new domain for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateUserPoolDomain {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_user_pool_domain_input::Builder,
}
impl CreateUserPoolDomain {
/// Creates a new `CreateUserPoolDomain`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateUserPoolDomain,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateUserPoolDomainError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateUserPoolDomainOutput,
aws_smithy_http::result::SdkError<crate::error::CreateUserPoolDomainError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p>
/// <p>Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.</p>
/// <p>For more information about the hosted domain and custom domains, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html">Configuring a User Pool Domain</a>.</p>
pub fn custom_domain_config(mut self, input: crate::model::CustomDomainConfigType) -> Self {
self.inner = self.inner.custom_domain_config(input);
self
}
/// <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p>
/// <p>Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.</p>
/// <p>For more information about the hosted domain and custom domains, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html">Configuring a User Pool Domain</a>.</p>
pub fn set_custom_domain_config(
mut self,
input: std::option::Option<crate::model::CustomDomainConfigType>,
) -> Self {
self.inner = self.inner.set_custom_domain_config(input);
self
}
}
/// Fluent builder constructing a request to `DeleteGroup`.
///
/// <p>Deletes a group.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_group_input::Builder,
}
impl DeleteGroup {
/// Creates a new `DeleteGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteGroupOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the group.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The name of the group.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteIdentityProvider`.
///
/// <p>Deletes an IdP for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteIdentityProvider {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_identity_provider_input::Builder,
}
impl DeleteIdentityProvider {
/// Creates a new `DeleteIdentityProvider`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteIdentityProvider,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteIdentityProviderError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteIdentityProviderOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteIdentityProviderError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The IdP name.</p>
pub fn provider_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.provider_name(input.into());
self
}
/// <p>The IdP name.</p>
pub fn set_provider_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_provider_name(input);
self
}
}
/// Fluent builder constructing a request to `DeleteResourceServer`.
///
/// <p>Deletes a resource server.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteResourceServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_resource_server_input::Builder,
}
impl DeleteResourceServer {
/// Creates a new `DeleteResourceServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteResourceServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteResourceServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteResourceServerOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteResourceServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that hosts the resource server.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that hosts the resource server.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The identifier for the resource server.</p>
pub fn identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.identifier(input.into());
self
}
/// <p>The identifier for the resource server.</p>
pub fn set_identifier(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_identifier(input);
self
}
}
/// Fluent builder constructing a request to `DeleteUser`.
///
/// <p>Allows a user to delete himself or herself.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_user_input::Builder,
}
impl DeleteUser {
/// Creates a new `DeleteUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteUserOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `DeleteUserAttributes`.
///
/// <p>Deletes the attributes for a user.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteUserAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_user_attributes_input::Builder,
}
impl DeleteUserAttributes {
/// Creates a new `DeleteUserAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteUserAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteUserAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteUserAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteUserAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Appends an item to `UserAttributeNames`.
///
/// To override the contents of this collection use [`set_user_attribute_names`](Self::set_user_attribute_names).
///
/// <p>An array of strings representing the user attribute names you want to delete.</p>
/// <p>For custom attributes, you must prependattach the <code>custom:</code> prefix to the front of the attribute name.</p>
pub fn user_attribute_names(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_attribute_names(input.into());
self
}
/// <p>An array of strings representing the user attribute names you want to delete.</p>
/// <p>For custom attributes, you must prependattach the <code>custom:</code> prefix to the front of the attribute name.</p>
pub fn set_user_attribute_names(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_user_attribute_names(input);
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `DeleteUserPool`.
///
/// <p>Deletes the specified Amazon Cognito user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteUserPool {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_user_pool_input::Builder,
}
impl DeleteUserPool {
/// Creates a new `DeleteUserPool`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteUserPool,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteUserPoolError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteUserPoolOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteUserPoolError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool you want to delete.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool you want to delete.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteUserPoolClient`.
///
/// <p>Allows the developer to delete the user pool client.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteUserPoolClient {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_user_pool_client_input::Builder,
}
impl DeleteUserPoolClient {
/// Creates a new `DeleteUserPoolClient`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteUserPoolClient,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteUserPoolClientError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteUserPoolClientOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteUserPoolClientError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to delete the client.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to delete the client.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The app client ID of the app associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID of the app associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteUserPoolDomain`.
///
/// <p>Deletes a domain for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteUserPoolDomain {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_user_pool_domain_input::Builder,
}
impl DeleteUserPoolDomain {
/// Creates a new `DeleteUserPoolDomain`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteUserPoolDomain,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteUserPoolDomainError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteUserPoolDomainOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteUserPoolDomainError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeIdentityProvider`.
///
/// <p>Gets information about a specific IdP.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeIdentityProvider {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_identity_provider_input::Builder,
}
impl DescribeIdentityProvider {
/// Creates a new `DescribeIdentityProvider`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeIdentityProvider,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeIdentityProviderError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeIdentityProviderOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeIdentityProviderError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The IdP name.</p>
pub fn provider_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.provider_name(input.into());
self
}
/// <p>The IdP name.</p>
pub fn set_provider_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_provider_name(input);
self
}
}
/// Fluent builder constructing a request to `DescribeResourceServer`.
///
/// <p>Describes a resource server.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeResourceServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_resource_server_input::Builder,
}
impl DescribeResourceServer {
/// Creates a new `DescribeResourceServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeResourceServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeResourceServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeResourceServerOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeResourceServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that hosts the resource server.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that hosts the resource server.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The identifier for the resource server</p>
pub fn identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.identifier(input.into());
self
}
/// <p>The identifier for the resource server</p>
pub fn set_identifier(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_identifier(input);
self
}
}
/// Fluent builder constructing a request to `DescribeRiskConfiguration`.
///
/// <p>Describes the risk configuration.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeRiskConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_risk_configuration_input::Builder,
}
impl DescribeRiskConfiguration {
/// Creates a new `DescribeRiskConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeRiskConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeRiskConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeRiskConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeRiskConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The app client ID.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeUserImportJob`.
///
/// <p>Describes the user import job.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeUserImportJob {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_user_import_job_input::Builder,
}
impl DescribeUserImportJob {
/// Creates a new `DescribeUserImportJob`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeUserImportJob,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeUserImportJobError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeUserImportJobOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeUserImportJobError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The job ID for the user import job.</p>
pub fn job_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.job_id(input.into());
self
}
/// <p>The job ID for the user import job.</p>
pub fn set_job_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_job_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeUserPool`.
///
/// <p>Returns the configuration information and metadata of the specified user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeUserPool {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_user_pool_input::Builder,
}
impl DescribeUserPool {
/// Creates a new `DescribeUserPool`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeUserPool,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeUserPoolError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeUserPoolOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeUserPoolError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool you want to describe.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool you want to describe.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeUserPoolClient`.
///
/// <p>Client method for returning the configuration information and metadata of the specified user pool app client.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeUserPoolClient {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_user_pool_client_input::Builder,
}
impl DescribeUserPoolClient {
/// Creates a new `DescribeUserPoolClient`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeUserPoolClient,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeUserPoolClientError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeUserPoolClientOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeUserPoolClientError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool you want to describe.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool you want to describe.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The app client ID of the app associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID of the app associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeUserPoolDomain`.
///
/// <p>Gets information about a domain.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeUserPoolDomain {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_user_pool_domain_input::Builder,
}
impl DescribeUserPoolDomain {
/// Creates a new `DescribeUserPoolDomain`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeUserPoolDomain,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeUserPoolDomainError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeUserPoolDomainOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeUserPoolDomainError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
}
/// Fluent builder constructing a request to `ForgetDevice`.
///
/// <p>Forgets the specified device.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ForgetDevice {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::forget_device_input::Builder,
}
impl ForgetDevice {
/// Creates a new `ForgetDevice`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ForgetDevice,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ForgetDeviceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ForgetDeviceOutput,
aws_smithy_http::result::SdkError<crate::error::ForgetDeviceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
}
/// Fluent builder constructing a request to `ForgotPassword`.
///
/// <p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the <code>Username</code> parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists, an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ForgotPassword {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::forgot_password_input::Builder,
}
impl ForgotPassword {
/// Creates a new `ForgotPassword`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ForgotPassword,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ForgotPasswordError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ForgotPasswordOutput,
aws_smithy_http::result::SdkError<crate::error::ForgotPasswordError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn secret_hash(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_hash(input.into());
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn set_secret_hash(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_hash(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
/// <p>The user name of the user for whom you want to enter a code to reset a forgotten password.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user for whom you want to enter a code to reset a forgotten password.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>ForgotPassword</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>ForgotPassword</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>user migration</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>user migration</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `GetCSVHeader`.
///
/// <p>Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetCSVHeader {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_csv_header_input::Builder,
}
impl GetCSVHeader {
/// Creates a new `GetCSVHeader`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetCSVHeader,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetCSVHeaderError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetCsvHeaderOutput,
aws_smithy_http::result::SdkError<crate::error::GetCSVHeaderError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that the users are to be imported into.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that the users are to be imported into.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `GetDevice`.
///
/// <p>Gets the device.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetDevice {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_device_input::Builder,
}
impl GetDevice {
/// Creates a new `GetDevice`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetDevice,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetDeviceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetDeviceOutput,
aws_smithy_http::result::SdkError<crate::error::GetDeviceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose device information you want to request.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose device information you want to request.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `GetGroup`.
///
/// <p>Gets a group.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_group_input::Builder,
}
impl GetGroup {
/// Creates a new `GetGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetGroupOutput,
aws_smithy_http::result::SdkError<crate::error::GetGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the group.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The name of the group.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `GetIdentityProviderByIdentifier`.
///
/// <p>Gets the specified IdP.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetIdentityProviderByIdentifier {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_identity_provider_by_identifier_input::Builder,
}
impl GetIdentityProviderByIdentifier {
/// Creates a new `GetIdentityProviderByIdentifier`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetIdentityProviderByIdentifier,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetIdentityProviderByIdentifierError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetIdentityProviderByIdentifierOutput,
aws_smithy_http::result::SdkError<crate::error::GetIdentityProviderByIdentifierError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The IdP identifier.</p>
pub fn idp_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.idp_identifier(input.into());
self
}
/// <p>The IdP identifier.</p>
pub fn set_idp_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_idp_identifier(input);
self
}
}
/// Fluent builder constructing a request to `GetSigningCertificate`.
///
/// <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p>
/// <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>, but doesn't invalidate the original certificate.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetSigningCertificate {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_signing_certificate_input::Builder,
}
impl GetSigningCertificate {
/// Creates a new `GetSigningCertificate`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetSigningCertificate,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetSigningCertificateError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetSigningCertificateOutput,
aws_smithy_http::result::SdkError<crate::error::GetSigningCertificateError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `GetUICustomization`.
///
/// <p>Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app <code>clientId</code> is <code>ALL</code>), then that information is returned. If nothing is present, then an empty shape is returned.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetUICustomization {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_ui_customization_input::Builder,
}
impl GetUICustomization {
/// Creates a new `GetUICustomization`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetUICustomization,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetUICustomizationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetUiCustomizationOutput,
aws_smithy_http::result::SdkError<crate::error::GetUICustomizationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The client ID for the client app.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The client ID for the client app.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
}
/// Fluent builder constructing a request to `GetUser`.
///
/// <p>Gets the user attributes and metadata for a user.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetUser {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_user_input::Builder,
}
impl GetUser {
/// Creates a new `GetUser`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetUser,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetUserError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetUserOutput,
aws_smithy_http::result::SdkError<crate::error::GetUserError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A non-expired access token for the user whose information you want to query.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A non-expired access token for the user whose information you want to query.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `GetUserAttributeVerificationCode`.
///
/// <p>Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetUserAttributeVerificationCode {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_user_attribute_verification_code_input::Builder,
}
impl GetUserAttributeVerificationCode {
/// Creates a new `GetUserAttributeVerificationCode`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetUserAttributeVerificationCode,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetUserAttributeVerificationCodeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetUserAttributeVerificationCodeOutput,
aws_smithy_http::result::SdkError<crate::error::GetUserAttributeVerificationCodeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A non-expired access token for the user whose attribute verification code you want to generate.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A non-expired access token for the user whose attribute verification code you want to generate.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The attribute name returned by the server response to get the user attribute verification code.</p>
pub fn attribute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attribute_name(input.into());
self
}
/// <p>The attribute name returned by the server response to get the user attribute verification code.</p>
pub fn set_attribute_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_attribute_name(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `GetUserPoolMfaConfig`.
///
/// <p>Gets the user pool multi-factor authentication (MFA) configuration.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetUserPoolMfaConfig {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_user_pool_mfa_config_input::Builder,
}
impl GetUserPoolMfaConfig {
/// Creates a new `GetUserPoolMfaConfig`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetUserPoolMfaConfig,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetUserPoolMfaConfigError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetUserPoolMfaConfigOutput,
aws_smithy_http::result::SdkError<crate::error::GetUserPoolMfaConfigError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
}
/// Fluent builder constructing a request to `GlobalSignOut`.
///
/// <p>Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GlobalSignOut {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::global_sign_out_input::Builder,
}
impl GlobalSignOut {
/// Creates a new `GlobalSignOut`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GlobalSignOut,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GlobalSignOutError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GlobalSignOutOutput,
aws_smithy_http::result::SdkError<crate::error::GlobalSignOutError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user who you want to sign out.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user who you want to sign out.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `InitiateAuth`.
///
/// <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct InitiateAuth {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::initiate_auth_input::Builder,
}
impl InitiateAuth {
/// Creates a new `InitiateAuth`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::InitiateAuth,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::InitiateAuthError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::InitiateAuthOutput,
aws_smithy_http::result::SdkError<crate::error::InitiateAuthError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The authentication flow for this call to run. The API action will depend on this value. For example:</p>
/// <ul>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code> takes in a valid refresh token and returns new tokens.</p> </li>
/// <li> <p> <code>USER_SRP_AUTH</code> takes in <code>USERNAME</code> and <code>SRP_A</code> and returns the SRP variables to be used for next challenge execution.</p> </li>
/// <li> <p> <code>USER_PASSWORD_AUTH</code> takes in <code>USERNAME</code> and <code>PASSWORD</code> and returns the next challenge or tokens.</p> </li>
/// </ul>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li>
/// <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li>
/// <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool. </p> </li>
/// </ul>
/// <p> <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
pub fn auth_flow(mut self, input: crate::model::AuthFlowType) -> Self {
self.inner = self.inner.auth_flow(input);
self
}
/// <p>The authentication flow for this call to run. The API action will depend on this value. For example:</p>
/// <ul>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code> takes in a valid refresh token and returns new tokens.</p> </li>
/// <li> <p> <code>USER_SRP_AUTH</code> takes in <code>USERNAME</code> and <code>SRP_A</code> and returns the SRP variables to be used for next challenge execution.</p> </li>
/// <li> <p> <code>USER_PASSWORD_AUTH</code> takes in <code>USERNAME</code> and <code>PASSWORD</code> and returns the next challenge or tokens.</p> </li>
/// </ul>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li>
/// <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li>
/// <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li>
/// <li> <p> <code>USER_PASSWORD_AUTH</code>: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool. </p> </li>
/// </ul>
/// <p> <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
pub fn set_auth_flow(
mut self,
input: std::option::Option<crate::model::AuthFlowType>,
) -> Self {
self.inner = self.inner.set_auth_flow(input);
self
}
/// Adds a key-value pair to `AuthParameters`.
///
/// To override the contents of this collection use [`set_auth_parameters`](Self::set_auth_parameters).
///
/// <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you're invoking. The required values depend on the value of <code>AuthFlow</code>:</p>
/// <ul>
/// <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code>. To start the authentication flow with password verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The SRP_A Value)</code>.</p> </li>
/// </ul>
pub fn auth_parameters(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.auth_parameters(k.into(), v.into());
self
}
/// <p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you're invoking. The required values depend on the value of <code>AuthFlow</code>:</p>
/// <ul>
/// <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code>. To start the authentication flow with password verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The SRP_A Value)</code>.</p> </li>
/// </ul>
pub fn set_auth_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_auth_parameters(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p>
/// <ul>
/// <li> <p>Pre signup</p> </li>
/// <li> <p>Pre authentication</p> </li>
/// <li> <p>User migration</p> </li>
/// </ul>
/// <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p>
/// <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
/// <ul>
/// <li> <p>Post authentication</p> </li>
/// <li> <p>Custom message</p> </li>
/// <li> <p>Pre token generation</p> </li>
/// <li> <p>Create auth challenge</p> </li>
/// <li> <p>Define auth challenge</p> </li>
/// <li> <p>Verify auth challenge</p> </li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p>
/// <ul>
/// <li> <p>Pre signup</p> </li>
/// <li> <p>Pre authentication</p> </li>
/// <li> <p>User migration</p> </li>
/// </ul>
/// <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p>
/// <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
/// <ul>
/// <li> <p>Post authentication</p> </li>
/// <li> <p>Custom message</p> </li>
/// <li> <p>Pre token generation</p> </li>
/// <li> <p>Create auth challenge</p> </li>
/// <li> <p>Define auth challenge</p> </li>
/// <li> <p>Verify auth challenge</p> </li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
/// <p>The app client ID.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>InitiateAuth</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>InitiateAuth</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
}
/// Fluent builder constructing a request to `ListDevices`.
///
/// <p>Lists the sign-in devices that Amazon Cognito has registered to the current user.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListDevices {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_devices_input::Builder,
}
impl ListDevices {
/// Creates a new `ListDevices`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListDevices,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListDevicesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListDevicesOutput,
aws_smithy_http::result::SdkError<crate::error::ListDevicesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The limit of the device request.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The limit of the device request.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>The pagination token for the list request.</p>
pub fn pagination_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.pagination_token(input.into());
self
}
/// <p>The pagination token for the list request.</p>
pub fn set_pagination_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_pagination_token(input);
self
}
}
/// Fluent builder constructing a request to `ListGroups`.
///
/// <p>Lists the groups associated with a user pool.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListGroups {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_groups_input::Builder,
}
impl ListGroups {
/// Creates a new `ListGroups`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListGroups,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListGroupsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListGroupsOutput,
aws_smithy_http::result::SdkError<crate::error::ListGroupsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListGroupsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListGroupsPaginator {
crate::paginator::ListGroupsPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The limit of the request to list groups.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The limit of the request to list groups.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListIdentityProviders`.
///
/// <p>Lists information about all IdPs for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListIdentityProviders {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_identity_providers_input::Builder,
}
impl ListIdentityProviders {
/// Creates a new `ListIdentityProviders`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListIdentityProviders,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListIdentityProvidersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListIdentityProvidersOutput,
aws_smithy_http::result::SdkError<crate::error::ListIdentityProvidersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListIdentityProvidersPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListIdentityProvidersPaginator {
crate::paginator::ListIdentityProvidersPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The maximum number of IdPs to return.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of IdPs to return.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>A pagination token.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A pagination token.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListResourceServers`.
///
/// <p>Lists the resource servers for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListResourceServers {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_resource_servers_input::Builder,
}
impl ListResourceServers {
/// Creates a new `ListResourceServers`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListResourceServers,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListResourceServersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListResourceServersOutput,
aws_smithy_http::result::SdkError<crate::error::ListResourceServersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListResourceServersPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListResourceServersPaginator {
crate::paginator::ListResourceServersPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The maximum number of resource servers to return.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of resource servers to return.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>A pagination token.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A pagination token.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListTagsForResource`.
///
/// <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
/// <p>A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.</p>
/// <p>You can use this action up to 10 times per second, per account.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListTagsForResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_tags_for_resource_input::Builder,
}
impl ListTagsForResource {
/// Creates a new `ListTagsForResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListTagsForResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListTagsForResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListTagsForResourceOutput,
aws_smithy_http::result::SdkError<crate::error::ListTagsForResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
}
/// Fluent builder constructing a request to `ListUserImportJobs`.
///
/// <p>Lists the user import jobs.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListUserImportJobs {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_user_import_jobs_input::Builder,
}
impl ListUserImportJobs {
/// Creates a new `ListUserImportJobs`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListUserImportJobs,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListUserImportJobsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListUserImportJobsOutput,
aws_smithy_http::result::SdkError<crate::error::ListUserImportJobsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The maximum number of import jobs you want the request to return.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of import jobs you want the request to return.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list.</p>
pub fn pagination_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.pagination_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list.</p>
pub fn set_pagination_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_pagination_token(input);
self
}
}
/// Fluent builder constructing a request to `ListUserPoolClients`.
///
/// <p>Lists the clients that have been created for the specified user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListUserPoolClients {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_user_pool_clients_input::Builder,
}
impl ListUserPoolClients {
/// Creates a new `ListUserPoolClients`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListUserPoolClients,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListUserPoolClientsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListUserPoolClientsOutput,
aws_smithy_http::result::SdkError<crate::error::ListUserPoolClientsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListUserPoolClientsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListUserPoolClientsPaginator {
crate::paginator::ListUserPoolClientsPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID for the user pool where you want to list user pool clients.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to list user pool clients.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The maximum number of results you want the request to return when listing the user pool clients.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of results you want the request to return when listing the user pool clients.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListUserPools`.
///
/// <p>Lists the user pools associated with an Amazon Web Services account.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListUserPools {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_user_pools_input::Builder,
}
impl ListUserPools {
/// Creates a new `ListUserPools`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListUserPools,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListUserPoolsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListUserPoolsOutput,
aws_smithy_http::result::SdkError<crate::error::ListUserPoolsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListUserPoolsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListUserPoolsPaginator {
crate::paginator::ListUserPoolsPaginator::new(self.handle, self.inner)
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of results you want the request to return when listing the user pools.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of results you want the request to return when listing the user pools.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
}
/// Fluent builder constructing a request to `ListUsers`.
///
/// <p>Lists the users in the Amazon Cognito user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListUsers {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_users_input::Builder,
}
impl ListUsers {
/// Creates a new `ListUsers`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListUsers,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListUsersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListUsersOutput,
aws_smithy_http::result::SdkError<crate::error::ListUsersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListUsersPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListUsersPaginator {
crate::paginator::ListUsersPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID for the user pool on which the search should be performed.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool on which the search should be performed.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// Appends an item to `AttributesToGet`.
///
/// To override the contents of this collection use [`set_attributes_to_get`](Self::set_attributes_to_get).
///
/// <p>An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.</p>
pub fn attributes_to_get(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attributes_to_get(input.into());
self
}
/// <p>An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.</p>
pub fn set_attributes_to_get(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_attributes_to_get(input);
self
}
/// <p>Maximum number of users to be returned.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>Maximum number of users to be returned.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn pagination_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.pagination_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn set_pagination_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_pagination_token(input);
self
}
/// <p>A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "<i>AttributeValue</i>"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "<code>family_name</code> = \"Reddy\"".</p>
/// <ul>
/// <li> <p> <i>AttributeName</i>: The name of the attribute to search for. You can only search for one attribute at a time.</p> </li>
/// <li> <p> <i>Filter-Type</i>: For an exact match, use =, for example, "<code>given_name</code> = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "<code>given_name</code> ^= \"Jon\"". </p> </li>
/// <li> <p> <i>AttributeValue</i>: The attribute value that must be matched for each user.</p> </li>
/// </ul>
/// <p>If the filter string is empty, <code>ListUsers</code> returns all users in the user pool.</p>
/// <p>You can only search for the following standard attributes:</p>
/// <ul>
/// <li> <p> <code>username</code> (case-sensitive)</p> </li>
/// <li> <p> <code>email</code> </p> </li>
/// <li> <p> <code>phone_number</code> </p> </li>
/// <li> <p> <code>name</code> </p> </li>
/// <li> <p> <code>given_name</code> </p> </li>
/// <li> <p> <code>family_name</code> </p> </li>
/// <li> <p> <code>preferred_username</code> </p> </li>
/// <li> <p> <code>cognito:user_status</code> (called <b>Status</b> in the Console) (case-insensitive)</p> </li>
/// <li> <p> <code>status (called <b>Enabled</b> in the Console) (case-sensitive)</code> </p> </li>
/// <li> <p> <code>sub</code> </p> </li>
/// </ul>
/// <p>Custom attributes aren't searchable.</p> <note>
/// <p>You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the <code>--query</code> parameter of the <code>list-users</code> action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result. </p>
/// <p>For more information about server-side and client-side filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">FilteringCLI output</a> in the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Command Line Interface User Guide</a>. </p>
/// </note>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api">Searching for Users Using the ListUsers API</a> and <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
pub fn filter(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.filter(input.into());
self
}
/// <p>A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "<i>AttributeValue</i>"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "<code>family_name</code> = \"Reddy\"".</p>
/// <ul>
/// <li> <p> <i>AttributeName</i>: The name of the attribute to search for. You can only search for one attribute at a time.</p> </li>
/// <li> <p> <i>Filter-Type</i>: For an exact match, use =, for example, "<code>given_name</code> = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "<code>given_name</code> ^= \"Jon\"". </p> </li>
/// <li> <p> <i>AttributeValue</i>: The attribute value that must be matched for each user.</p> </li>
/// </ul>
/// <p>If the filter string is empty, <code>ListUsers</code> returns all users in the user pool.</p>
/// <p>You can only search for the following standard attributes:</p>
/// <ul>
/// <li> <p> <code>username</code> (case-sensitive)</p> </li>
/// <li> <p> <code>email</code> </p> </li>
/// <li> <p> <code>phone_number</code> </p> </li>
/// <li> <p> <code>name</code> </p> </li>
/// <li> <p> <code>given_name</code> </p> </li>
/// <li> <p> <code>family_name</code> </p> </li>
/// <li> <p> <code>preferred_username</code> </p> </li>
/// <li> <p> <code>cognito:user_status</code> (called <b>Status</b> in the Console) (case-insensitive)</p> </li>
/// <li> <p> <code>status (called <b>Enabled</b> in the Console) (case-sensitive)</code> </p> </li>
/// <li> <p> <code>sub</code> </p> </li>
/// </ul>
/// <p>Custom attributes aren't searchable.</p> <note>
/// <p>You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the <code>--query</code> parameter of the <code>list-users</code> action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result. </p>
/// <p>For more information about server-side and client-side filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">FilteringCLI output</a> in the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Command Line Interface User Guide</a>. </p>
/// </note>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api">Searching for Users Using the ListUsers API</a> and <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
pub fn set_filter(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_filter(input);
self
}
}
/// Fluent builder constructing a request to `ListUsersInGroup`.
///
/// <p>Lists the users in the specified group.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListUsersInGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_users_in_group_input::Builder,
}
impl ListUsersInGroup {
/// Creates a new `ListUsersInGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListUsersInGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListUsersInGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListUsersInGroupOutput,
aws_smithy_http::result::SdkError<crate::error::ListUsersInGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListUsersInGroupPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListUsersInGroupPaginator {
crate::paginator::ListUsersInGroupPaginator::new(self.handle, self.inner)
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The name of the group.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The name of the group.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
/// <p>The limit of the request to list users.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The limit of the request to list users.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ResendConfirmationCode`.
///
/// <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ResendConfirmationCode {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::resend_confirmation_code_input::Builder,
}
impl ResendConfirmationCode {
/// Creates a new `ResendConfirmationCode`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ResendConfirmationCode,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ResendConfirmationCodeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ResendConfirmationCodeOutput,
aws_smithy_http::result::SdkError<crate::error::ResendConfirmationCodeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn secret_hash(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_hash(input.into());
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn set_secret_hash(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_hash(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
/// <p>The <code>username</code> attribute of the user to whom you want to resend a confirmation code.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The <code>username</code> attribute of the user to whom you want to resend a confirmation code.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>ResendConfirmationCode</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>ResendConfirmationCode</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `RespondToAuthChallenge`.
///
/// <p>Responds to the authentication challenge.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RespondToAuthChallenge {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::respond_to_auth_challenge_input::Builder,
}
impl RespondToAuthChallenge {
/// Creates a new `RespondToAuthChallenge`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::RespondToAuthChallenge,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::RespondToAuthChallengeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::RespondToAuthChallengeOutput,
aws_smithy_http::result::SdkError<crate::error::RespondToAuthChallengeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The app client ID.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
/// <p> <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
pub fn challenge_name(mut self, input: crate::model::ChallengeNameType) -> Self {
self.inner = self.inner.challenge_name(input);
self
}
/// <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
/// <p> <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
pub fn set_challenge_name(
mut self,
input: std::option::Option<crate::model::ChallengeNameType>,
) -> Self {
self.inner = self.inner.set_challenge_name(input);
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
pub fn session(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.session(input.into());
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>
pub fn set_session(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_session(input);
self
}
/// Adds a key-value pair to `ChallengeResponses`.
///
/// To override the contents of this collection use [`set_challenge_responses`](Self::set_challenge_responses).
///
/// <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <note>
/// <p> <code>SECRET_HASH</code> (if app client is configured with client secret) applies to all of the inputs that follow (including <code>SOFTWARE_TOKEN_MFA</code>).</p>
/// </note>
/// <ul>
/// <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>.</p> </li>
/// <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>.</p> <note>
/// <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when you sign in with a remembered device.</p>
/// </note> </li>
/// <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>InitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren't required by your user pool.</p> <note>
/// <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
/// </note> </li>
/// <li> <p> <code>SOFTWARE_TOKEN_MFA</code>: <code>USERNAME</code> and <code>SOFTWARE_TOKEN_MFA_CODE</code> are required attributes.</p> </li>
/// <li> <p> <code>DEVICE_SRP_AUTH</code> requires <code>USERNAME</code>, <code>DEVICE_KEY</code>, <code>SRP_A</code> (and <code>SECRET_HASH</code>).</p> </li>
/// <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code> requires everything that <code>PASSWORD_VERIFIER</code> requires, plus <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li>
/// </ul>
pub fn challenge_responses(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.challenge_responses(k.into(), v.into());
self
}
/// <p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <note>
/// <p> <code>SECRET_HASH</code> (if app client is configured with client secret) applies to all of the inputs that follow (including <code>SOFTWARE_TOKEN_MFA</code>).</p>
/// </note>
/// <ul>
/// <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>.</p> </li>
/// <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>.</p> <note>
/// <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when you sign in with a remembered device.</p>
/// </note> </li>
/// <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>InitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren't required by your user pool.</p> <note>
/// <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value. In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
/// </note> </li>
/// <li> <p> <code>SOFTWARE_TOKEN_MFA</code>: <code>USERNAME</code> and <code>SOFTWARE_TOKEN_MFA_CODE</code> are required attributes.</p> </li>
/// <li> <p> <code>DEVICE_SRP_AUTH</code> requires <code>USERNAME</code>, <code>DEVICE_KEY</code>, <code>SRP_A</code> (and <code>SECRET_HASH</code>).</p> </li>
/// <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code> requires everything that <code>PASSWORD_VERIFIER</code> requires, plus <code>DEVICE_KEY</code>.</p> </li>
/// <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li>
/// </ul>
pub fn set_challenge_responses(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_challenge_responses(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>RespondToAuthChallenge</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>RespondToAuthChallenge</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>post authentication</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>post authentication</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `RevokeToken`.
///
/// <p>Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RevokeToken {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::revoke_token_input::Builder,
}
impl RevokeToken {
/// Creates a new `RevokeToken`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::RevokeToken,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::RevokeTokenError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::RevokeTokenOutput,
aws_smithy_http::result::SdkError<crate::error::RevokeTokenError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The refresh token that you want to revoke.</p>
pub fn token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.token(input.into());
self
}
/// <p>The refresh token that you want to revoke.</p>
pub fn set_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_token(input);
self
}
/// <p>The client ID for the token that you want to revoke.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The client ID for the token that you want to revoke.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The secret for the client ID. This is required only if the client ID has a secret.</p>
pub fn client_secret(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_secret(input.into());
self
}
/// <p>The secret for the client ID. This is required only if the client ID has a secret.</p>
pub fn set_client_secret(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_client_secret(input);
self
}
}
/// Fluent builder constructing a request to `SetRiskConfiguration`.
///
/// <p>Configures actions on detected risks. To delete the risk configuration for <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four configuration types.</p>
/// <p>To activate Amazon Cognito advanced security features, update the user pool to include the <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetRiskConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_risk_configuration_input::Builder,
}
impl SetRiskConfiguration {
/// Creates a new `SetRiskConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetRiskConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetRiskConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetRiskConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::SetRiskConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID. </p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID. </p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is mapped to <code>userPoolId</code>. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.</p>
/// <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is mapped to <code>userPoolId</code>. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.</p>
/// <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The compromised credentials risk configuration.</p>
pub fn compromised_credentials_risk_configuration(
mut self,
input: crate::model::CompromisedCredentialsRiskConfigurationType,
) -> Self {
self.inner = self.inner.compromised_credentials_risk_configuration(input);
self
}
/// <p>The compromised credentials risk configuration.</p>
pub fn set_compromised_credentials_risk_configuration(
mut self,
input: std::option::Option<crate::model::CompromisedCredentialsRiskConfigurationType>,
) -> Self {
self.inner = self
.inner
.set_compromised_credentials_risk_configuration(input);
self
}
/// <p>The account takeover risk configuration.</p>
pub fn account_takeover_risk_configuration(
mut self,
input: crate::model::AccountTakeoverRiskConfigurationType,
) -> Self {
self.inner = self.inner.account_takeover_risk_configuration(input);
self
}
/// <p>The account takeover risk configuration.</p>
pub fn set_account_takeover_risk_configuration(
mut self,
input: std::option::Option<crate::model::AccountTakeoverRiskConfigurationType>,
) -> Self {
self.inner = self.inner.set_account_takeover_risk_configuration(input);
self
}
/// <p>The configuration to override the risk decision.</p>
pub fn risk_exception_configuration(
mut self,
input: crate::model::RiskExceptionConfigurationType,
) -> Self {
self.inner = self.inner.risk_exception_configuration(input);
self
}
/// <p>The configuration to override the risk decision.</p>
pub fn set_risk_exception_configuration(
mut self,
input: std::option::Option<crate::model::RiskExceptionConfigurationType>,
) -> Self {
self.inner = self.inner.set_risk_exception_configuration(input);
self
}
}
/// Fluent builder constructing a request to `SetUICustomization`.
///
/// <p>Sets the user interface (UI) customization information for a user pool's built-in app UI.</p>
/// <p>You can specify app UI customization settings for a single client (with a specific <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the <code>ALL</code> configuration.</p> <note>
/// <p>To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetUICustomization {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_ui_customization_input::Builder,
}
impl SetUICustomization {
/// Creates a new `SetUICustomization`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetUICustomization,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetUICustomizationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetUiCustomizationOutput,
aws_smithy_http::result::SdkError<crate::error::SetUICustomizationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The client ID for the client app.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The client ID for the client app.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The CSS values in the UI customization.</p>
pub fn css(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.css(input.into());
self
}
/// <p>The CSS values in the UI customization.</p>
pub fn set_css(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_css(input);
self
}
/// <p>The uploaded logo image for the UI customization.</p>
pub fn image_file(mut self, input: aws_smithy_types::Blob) -> Self {
self.inner = self.inner.image_file(input);
self
}
/// <p>The uploaded logo image for the UI customization.</p>
pub fn set_image_file(
mut self,
input: std::option::Option<aws_smithy_types::Blob>,
) -> Self {
self.inner = self.inner.set_image_file(input);
self
}
}
/// Fluent builder constructing a request to `SetUserMFAPreference`.
///
/// <p>Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetUserMFAPreference {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_user_mfa_preference_input::Builder,
}
impl SetUserMFAPreference {
/// Creates a new `SetUserMFAPreference`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetUserMFAPreference,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetUserMFAPreferenceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetUserMfaPreferenceOutput,
aws_smithy_http::result::SdkError<crate::error::SetUserMFAPreferenceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The SMS text message multi-factor authentication (MFA) settings.</p>
pub fn sms_mfa_settings(mut self, input: crate::model::SmsMfaSettingsType) -> Self {
self.inner = self.inner.sms_mfa_settings(input);
self
}
/// <p>The SMS text message multi-factor authentication (MFA) settings.</p>
pub fn set_sms_mfa_settings(
mut self,
input: std::option::Option<crate::model::SmsMfaSettingsType>,
) -> Self {
self.inner = self.inner.set_sms_mfa_settings(input);
self
}
/// <p>The time-based one-time password (TOTP) software token MFA settings.</p>
pub fn software_token_mfa_settings(
mut self,
input: crate::model::SoftwareTokenMfaSettingsType,
) -> Self {
self.inner = self.inner.software_token_mfa_settings(input);
self
}
/// <p>The time-based one-time password (TOTP) software token MFA settings.</p>
pub fn set_software_token_mfa_settings(
mut self,
input: std::option::Option<crate::model::SoftwareTokenMfaSettingsType>,
) -> Self {
self.inner = self.inner.set_software_token_mfa_settings(input);
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
}
/// Fluent builder constructing a request to `SetUserPoolMfaConfig`.
///
/// <p>Sets the user pool multi-factor authentication (MFA) configuration.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetUserPoolMfaConfig {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_user_pool_mfa_config_input::Builder,
}
impl SetUserPoolMfaConfig {
/// Creates a new `SetUserPoolMfaConfig`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetUserPoolMfaConfig,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetUserPoolMfaConfigError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetUserPoolMfaConfigOutput,
aws_smithy_http::result::SdkError<crate::error::SetUserPoolMfaConfigError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The SMS text message MFA configuration.</p>
pub fn sms_mfa_configuration(mut self, input: crate::model::SmsMfaConfigType) -> Self {
self.inner = self.inner.sms_mfa_configuration(input);
self
}
/// <p>The SMS text message MFA configuration.</p>
pub fn set_sms_mfa_configuration(
mut self,
input: std::option::Option<crate::model::SmsMfaConfigType>,
) -> Self {
self.inner = self.inner.set_sms_mfa_configuration(input);
self
}
/// <p>The software token MFA configuration.</p>
pub fn software_token_mfa_configuration(
mut self,
input: crate::model::SoftwareTokenMfaConfigType,
) -> Self {
self.inner = self.inner.software_token_mfa_configuration(input);
self
}
/// <p>The software token MFA configuration.</p>
pub fn set_software_token_mfa_configuration(
mut self,
input: std::option::Option<crate::model::SoftwareTokenMfaConfigType>,
) -> Self {
self.inner = self.inner.set_software_token_mfa_configuration(input);
self
}
/// <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor Authentication (MFA) to a user pool</a>. Valid values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li>
/// <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li>
/// <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li>
/// </ul>
pub fn mfa_configuration(mut self, input: crate::model::UserPoolMfaType) -> Self {
self.inner = self.inner.mfa_configuration(input);
self
}
/// <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor Authentication (MFA) to a user pool</a>. Valid values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li>
/// <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li>
/// <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li>
/// </ul>
pub fn set_mfa_configuration(
mut self,
input: std::option::Option<crate::model::UserPoolMfaType>,
) -> Self {
self.inner = self.inner.set_mfa_configuration(input);
self
}
}
/// Fluent builder constructing a request to `SetUserSettings`.
///
/// <p> <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SetUserSettings {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::set_user_settings_input::Builder,
}
impl SetUserSettings {
/// Creates a new `SetUserSettings`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SetUserSettings,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SetUserSettingsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SetUserSettingsOutput,
aws_smithy_http::result::SdkError<crate::error::SetUserSettingsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// Appends an item to `MFAOptions`.
///
/// To override the contents of this collection use [`set_mfa_options`](Self::set_mfa_options).
///
/// <p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>
pub fn mfa_options(mut self, input: crate::model::MfaOptionType) -> Self {
self.inner = self.inner.mfa_options(input);
self
}
/// <p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p>
pub fn set_mfa_options(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::MfaOptionType>>,
) -> Self {
self.inner = self.inner.set_mfa_options(input);
self
}
}
/// Fluent builder constructing a request to `SignUp`.
///
/// <p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SignUp {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::sign_up_input::Builder,
}
impl SignUp {
/// Creates a new `SignUp`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SignUp,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SignUpError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SignUpOutput,
aws_smithy_http::result::SdkError<crate::error::SignUpError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn secret_hash(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_hash(input.into());
self
}
/// <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.</p>
pub fn set_secret_hash(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_hash(input);
self
}
/// <p>The user name of the user you want to register.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user name of the user you want to register.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The password of the user you want to register.</p>
pub fn password(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.password(input.into());
self
}
/// <p>The password of the user you want to register.</p>
pub fn set_password(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_password(input);
self
}
/// Appends an item to `UserAttributes`.
///
/// To override the contents of this collection use [`set_user_attributes`](Self::set_user_attributes).
///
/// <p>An array of name-value pairs representing user attributes.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
pub fn user_attributes(mut self, input: crate::model::AttributeType) -> Self {
self.inner = self.inner.user_attributes(input);
self
}
/// <p>An array of name-value pairs representing user attributes.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
pub fn set_user_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AttributeType>>,
) -> Self {
self.inner = self.inner.set_user_attributes(input);
self
}
/// Appends an item to `ValidationData`.
///
/// To override the contents of this collection use [`set_validation_data`](Self::set_validation_data).
///
/// <p>The validation data in the request to register a user.</p>
pub fn validation_data(mut self, input: crate::model::AttributeType) -> Self {
self.inner = self.inner.validation_data(input);
self
}
/// <p>The validation data in the request to register a user.</p>
pub fn set_validation_data(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AttributeType>>,
) -> Self {
self.inner = self.inner.set_validation_data(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>SignUp</code> calls.</p>
pub fn analytics_metadata(mut self, input: crate::model::AnalyticsMetadataType) -> Self {
self.inner = self.inner.analytics_metadata(input);
self
}
/// <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for <code>SignUp</code> calls.</p>
pub fn set_analytics_metadata(
mut self,
input: std::option::Option<crate::model::AnalyticsMetadataType>,
) -> Self {
self.inner = self.inner.set_analytics_metadata(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn user_context_data(mut self, input: crate::model::UserContextDataType) -> Self {
self.inner = self.inner.user_context_data(input);
self
}
/// <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.</p>
pub fn set_user_context_data(
mut self,
input: std::option::Option<crate::model::UserContextDataType>,
) -> Self {
self.inner = self.inner.set_user_context_data(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `StartUserImportJob`.
///
/// <p>Starts the user import.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartUserImportJob {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::start_user_import_job_input::Builder,
}
impl StartUserImportJob {
/// Creates a new `StartUserImportJob`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StartUserImportJob,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StartUserImportJobError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StartUserImportJobOutput,
aws_smithy_http::result::SdkError<crate::error::StartUserImportJobError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The job ID for the user import job.</p>
pub fn job_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.job_id(input.into());
self
}
/// <p>The job ID for the user import job.</p>
pub fn set_job_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_job_id(input);
self
}
}
/// Fluent builder constructing a request to `StopUserImportJob`.
///
/// <p>Stops the user import job.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StopUserImportJob {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::stop_user_import_job_input::Builder,
}
impl StopUserImportJob {
/// Creates a new `StopUserImportJob`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StopUserImportJob,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StopUserImportJobError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StopUserImportJobOutput,
aws_smithy_http::result::SdkError<crate::error::StopUserImportJobError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool that the users are being imported into.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The job ID for the user import job.</p>
pub fn job_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.job_id(input.into());
self
}
/// <p>The job ID for the user import job.</p>
pub fn set_job_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_job_id(input);
self
}
}
/// Fluent builder constructing a request to `TagResource`.
///
/// <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
/// <p>Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an <code>Environment</code> tag key to both user pools. The value of this key might be <code>Test</code> for one user pool, and <code>Production</code> for the other.</p>
/// <p>Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.</p>
/// <p>You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct TagResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::tag_resource_input::Builder,
}
impl TagResource {
/// Creates a new `TagResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::TagResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::TagResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::TagResourceOutput,
aws_smithy_http::result::SdkError<crate::error::TagResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// Adds a key-value pair to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags to assign to the user pool.</p>
pub fn tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.tags(k.into(), v.into());
self
}
/// <p>The tags to assign to the user pool.</p>
pub fn set_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `UntagResource`.
///
/// <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UntagResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::untag_resource_input::Builder,
}
impl UntagResource {
/// Creates a new `UntagResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UntagResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UntagResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UntagResourceOutput,
aws_smithy_http::result::SdkError<crate::error::UntagResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// Appends an item to `TagKeys`.
///
/// To override the contents of this collection use [`set_tag_keys`](Self::set_tag_keys).
///
/// <p>The keys of the tags to remove from the user pool.</p>
pub fn tag_keys(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.tag_keys(input.into());
self
}
/// <p>The keys of the tags to remove from the user pool.</p>
pub fn set_tag_keys(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_tag_keys(input);
self
}
}
/// Fluent builder constructing a request to `UpdateAuthEventFeedback`.
///
/// <p>Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateAuthEventFeedback {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_auth_event_feedback_input::Builder,
}
impl UpdateAuthEventFeedback {
/// Creates a new `UpdateAuthEventFeedback`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateAuthEventFeedback,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateAuthEventFeedbackError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateAuthEventFeedbackOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateAuthEventFeedbackError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user pool username.</p>
pub fn username(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.username(input.into());
self
}
/// <p>The user pool username.</p>
pub fn set_username(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_username(input);
self
}
/// <p>The event ID.</p>
pub fn event_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.event_id(input.into());
self
}
/// <p>The event ID.</p>
pub fn set_event_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_event_id(input);
self
}
/// <p>The feedback token.</p>
pub fn feedback_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.feedback_token(input.into());
self
}
/// <p>The feedback token.</p>
pub fn set_feedback_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_feedback_token(input);
self
}
/// <p>The authentication event feedback value.</p>
pub fn feedback_value(mut self, input: crate::model::FeedbackValueType) -> Self {
self.inner = self.inner.feedback_value(input);
self
}
/// <p>The authentication event feedback value.</p>
pub fn set_feedback_value(
mut self,
input: std::option::Option<crate::model::FeedbackValueType>,
) -> Self {
self.inner = self.inner.set_feedback_value(input);
self
}
}
/// Fluent builder constructing a request to `UpdateDeviceStatus`.
///
/// <p>Updates the device status.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateDeviceStatus {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_device_status_input::Builder,
}
impl UpdateDeviceStatus {
/// Creates a new `UpdateDeviceStatus`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateDeviceStatus,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateDeviceStatusError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateDeviceStatusOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateDeviceStatusError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose device status you want to update.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose device status you want to update.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The device key.</p>
pub fn device_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.device_key(input.into());
self
}
/// <p>The device key.</p>
pub fn set_device_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_device_key(input);
self
}
/// <p>The status of whether a device is remembered.</p>
pub fn device_remembered_status(
mut self,
input: crate::model::DeviceRememberedStatusType,
) -> Self {
self.inner = self.inner.device_remembered_status(input);
self
}
/// <p>The status of whether a device is remembered.</p>
pub fn set_device_remembered_status(
mut self,
input: std::option::Option<crate::model::DeviceRememberedStatusType>,
) -> Self {
self.inner = self.inner.set_device_remembered_status(input);
self
}
}
/// Fluent builder constructing a request to `UpdateGroup`.
///
/// <p>Updates the specified group with the specified attributes.</p>
/// <p>Calling this action requires developer credentials.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_group_input::Builder,
}
impl UpdateGroup {
/// Creates a new `UpdateGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateGroupOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the group.</p>
pub fn group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.group_name(input.into());
self
}
/// <p>The name of the group.</p>
pub fn set_group_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_group_name(input);
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>A string containing the new description of the group.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A string containing the new description of the group.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the token.</p>
pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_arn(input.into());
self
}
/// <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the token.</p>
pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_arn(input);
self
}
/// <p>The new precedence value for the group. For more information about this parameter, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
pub fn precedence(mut self, input: i32) -> Self {
self.inner = self.inner.precedence(input);
self
}
/// <p>The new precedence value for the group. For more information about this parameter, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
pub fn set_precedence(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_precedence(input);
self
}
}
/// Fluent builder constructing a request to `UpdateIdentityProvider`.
///
/// <p>Updates IdP information for a user pool.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateIdentityProvider {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_identity_provider_input::Builder,
}
impl UpdateIdentityProvider {
/// Creates a new `UpdateIdentityProvider`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateIdentityProvider,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateIdentityProviderError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateIdentityProviderOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateIdentityProviderError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The IdP name.</p>
pub fn provider_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.provider_name(input.into());
self
}
/// <p>The IdP name.</p>
pub fn set_provider_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_provider_name(input);
self
}
/// Adds a key-value pair to `ProviderDetails`.
///
/// To override the contents of this collection use [`set_provider_details`](Self::set_provider_details).
///
/// <p>The IdP details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
pub fn provider_details(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.provider_details(k.into(), v.into());
self
}
/// <p>The IdP details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>
pub fn set_provider_details(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_provider_details(input);
self
}
/// Adds a key-value pair to `AttributeMapping`.
///
/// To override the contents of this collection use [`set_attribute_mapping`](Self::set_attribute_mapping).
///
/// <p>The IdP attribute mapping to be changed.</p>
pub fn attribute_mapping(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.attribute_mapping(k.into(), v.into());
self
}
/// <p>The IdP attribute mapping to be changed.</p>
pub fn set_attribute_mapping(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_attribute_mapping(input);
self
}
/// Appends an item to `IdpIdentifiers`.
///
/// To override the contents of this collection use [`set_idp_identifiers`](Self::set_idp_identifiers).
///
/// <p>A list of IdP identifiers.</p>
pub fn idp_identifiers(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.idp_identifiers(input.into());
self
}
/// <p>A list of IdP identifiers.</p>
pub fn set_idp_identifiers(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_idp_identifiers(input);
self
}
}
/// Fluent builder constructing a request to `UpdateResourceServer`.
///
/// <p>Updates the name and scopes of resource server. All other fields are read-only.</p> <important>
/// <p>If you don't provide a value for an attribute, it is set to the default value.</p>
/// </important>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateResourceServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_resource_server_input::Builder,
}
impl UpdateResourceServer {
/// Creates a new `UpdateResourceServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateResourceServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateResourceServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateResourceServerOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateResourceServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The identifier for the resource server.</p>
pub fn identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.identifier(input.into());
self
}
/// <p>The identifier for the resource server.</p>
pub fn set_identifier(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_identifier(input);
self
}
/// <p>The name of the resource server.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The name of the resource server.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// Appends an item to `Scopes`.
///
/// To override the contents of this collection use [`set_scopes`](Self::set_scopes).
///
/// <p>The scope values to be set for the resource server.</p>
pub fn scopes(mut self, input: crate::model::ResourceServerScopeType) -> Self {
self.inner = self.inner.scopes(input);
self
}
/// <p>The scope values to be set for the resource server.</p>
pub fn set_scopes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::ResourceServerScopeType>>,
) -> Self {
self.inner = self.inner.set_scopes(input);
self
}
}
/// Fluent builder constructing a request to `UpdateUserAttributes`.
///
/// <p>Allows a user to update a specific attribute (one at a time).</p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateUserAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_user_attributes_input::Builder,
}
impl UpdateUserAttributes {
/// Creates a new `UpdateUserAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateUserAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateUserAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateUserAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateUserAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Appends an item to `UserAttributes`.
///
/// To override the contents of this collection use [`set_user_attributes`](Self::set_user_attributes).
///
/// <p>An array of name-value pairs representing user attributes.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.</p>
pub fn user_attributes(mut self, input: crate::model::AttributeType) -> Self {
self.inner = self.inner.user_attributes(input);
self
}
/// <p>An array of name-value pairs representing user attributes.</p>
/// <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
/// <p>If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.</p>
pub fn set_user_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::AttributeType>>,
) -> Self {
self.inner = self.inner.set_user_attributes(input);
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// Adds a key-value pair to `ClientMetadata`.
///
/// To override the contents of this collection use [`set_client_metadata`](Self::set_client_metadata).
///
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. </p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn client_metadata(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.client_metadata(k.into(), v.into());
self
}
/// <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. </p>
/// <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note>
/// <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
/// <ul>
/// <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li>
/// <li> <p>Validate the ClientMetadata value.</p> </li>
/// <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li>
/// </ul>
/// </note>
pub fn set_client_metadata(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_client_metadata(input);
self
}
}
/// Fluent builder constructing a request to `UpdateUserPool`.
///
/// <p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be set to the default value. </p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateUserPool {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_user_pool_input::Builder,
}
impl UpdateUserPool {
/// Creates a new `UpdateUserPool`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateUserPool,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateUserPoolError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateUserPoolOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateUserPoolError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool you want to update.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool you want to update.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>A container with the policies you want to update in a user pool.</p>
pub fn policies(mut self, input: crate::model::UserPoolPolicyType) -> Self {
self.inner = self.inner.policies(input);
self
}
/// <p>A container with the policies you want to update in a user pool.</p>
pub fn set_policies(
mut self,
input: std::option::Option<crate::model::UserPoolPolicyType>,
) -> Self {
self.inner = self.inner.set_policies(input);
self
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn deletion_protection(mut self, input: crate::model::DeletionProtectionType) -> Self {
self.inner = self.inner.deletion_protection(input);
self
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn set_deletion_protection(
mut self,
input: std::option::Option<crate::model::DeletionProtectionType>,
) -> Self {
self.inner = self.inner.set_deletion_protection(input);
self
}
/// <p>The Lambda configuration information from the request to update the user pool.</p>
pub fn lambda_config(mut self, input: crate::model::LambdaConfigType) -> Self {
self.inner = self.inner.lambda_config(input);
self
}
/// <p>The Lambda configuration information from the request to update the user pool.</p>
pub fn set_lambda_config(
mut self,
input: std::option::Option<crate::model::LambdaConfigType>,
) -> Self {
self.inner = self.inner.set_lambda_config(input);
self
}
/// Appends an item to `AutoVerifiedAttributes`.
///
/// To override the contents of this collection use [`set_auto_verified_attributes`](Self::set_auto_verified_attributes).
///
/// <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
pub fn auto_verified_attributes(
mut self,
input: crate::model::VerifiedAttributeType,
) -> Self {
self.inner = self.inner.auto_verified_attributes(input);
self
}
/// <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
pub fn set_auto_verified_attributes(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::VerifiedAttributeType>>,
) -> Self {
self.inner = self.inner.set_auto_verified_attributes(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn sms_verification_message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sms_verification_message(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_sms_verification_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_sms_verification_message(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn email_verification_message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.email_verification_message(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_email_verification_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_email_verification_message(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn email_verification_subject(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.email_verification_subject(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_email_verification_subject(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_email_verification_subject(input);
self
}
/// <p>The template for verification messages.</p>
pub fn verification_message_template(
mut self,
input: crate::model::VerificationMessageTemplateType,
) -> Self {
self.inner = self.inner.verification_message_template(input);
self
}
/// <p>The template for verification messages.</p>
pub fn set_verification_message_template(
mut self,
input: std::option::Option<crate::model::VerificationMessageTemplateType>,
) -> Self {
self.inner = self.inner.set_verification_message_template(input);
self
}
/// <p>The contents of the SMS authentication message.</p>
pub fn sms_authentication_message(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sms_authentication_message(input.into());
self
}
/// <p>The contents of the SMS authentication message.</p>
pub fn set_sms_authentication_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_sms_authentication_message(input);
self
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn user_attribute_update_settings(
mut self,
input: crate::model::UserAttributeUpdateSettingsType,
) -> Self {
self.inner = self.inner.user_attribute_update_settings(input);
self
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn set_user_attribute_update_settings(
mut self,
input: std::option::Option<crate::model::UserAttributeUpdateSettingsType>,
) -> Self {
self.inner = self.inner.set_user_attribute_update_settings(input);
self
}
/// <p>Possible values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li>
/// <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li>
/// <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li>
/// </ul>
pub fn mfa_configuration(mut self, input: crate::model::UserPoolMfaType) -> Self {
self.inner = self.inner.mfa_configuration(input);
self
}
/// <p>Possible values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li>
/// <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li>
/// <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li>
/// </ul>
pub fn set_mfa_configuration(
mut self,
input: std::option::Option<crate::model::UserPoolMfaType>,
) -> Self {
self.inner = self.inner.set_mfa_configuration(input);
self
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn device_configuration(
mut self,
input: crate::model::DeviceConfigurationType,
) -> Self {
self.inner = self.inner.device_configuration(input);
self
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn set_device_configuration(
mut self,
input: std::option::Option<crate::model::DeviceConfigurationType>,
) -> Self {
self.inner = self.inner.set_device_configuration(input);
self
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>
pub fn email_configuration(mut self, input: crate::model::EmailConfigurationType) -> Self {
self.inner = self.inner.email_configuration(input);
self
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>
pub fn set_email_configuration(
mut self,
input: std::option::Option<crate::model::EmailConfigurationType>,
) -> Self {
self.inner = self.inner.set_email_configuration(input);
self
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn sms_configuration(mut self, input: crate::model::SmsConfigurationType) -> Self {
self.inner = self.inner.sms_configuration(input);
self
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn set_sms_configuration(
mut self,
input: std::option::Option<crate::model::SmsConfigurationType>,
) -> Self {
self.inner = self.inner.set_sms_configuration(input);
self
}
/// Adds a key-value pair to `UserPoolTags`.
///
/// To override the contents of this collection use [`set_user_pool_tags`](Self::set_user_pool_tags).
///
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn user_pool_tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.user_pool_tags(k.into(), v.into());
self
}
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn set_user_pool_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_user_pool_tags(input);
self
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn admin_create_user_config(
mut self,
input: crate::model::AdminCreateUserConfigType,
) -> Self {
self.inner = self.inner.admin_create_user_config(input);
self
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn set_admin_create_user_config(
mut self,
input: std::option::Option<crate::model::AdminCreateUserConfigType>,
) -> Self {
self.inner = self.inner.set_admin_create_user_config(input);
self
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn user_pool_add_ons(mut self, input: crate::model::UserPoolAddOnsType) -> Self {
self.inner = self.inner.user_pool_add_ons(input);
self
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn set_user_pool_add_ons(
mut self,
input: std::option::Option<crate::model::UserPoolAddOnsType>,
) -> Self {
self.inner = self.inner.set_user_pool_add_ons(input);
self
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn account_recovery_setting(
mut self,
input: crate::model::AccountRecoverySettingType,
) -> Self {
self.inner = self.inner.account_recovery_setting(input);
self
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn set_account_recovery_setting(
mut self,
input: std::option::Option<crate::model::AccountRecoverySettingType>,
) -> Self {
self.inner = self.inner.set_account_recovery_setting(input);
self
}
}
/// Fluent builder constructing a request to `UpdateUserPoolClient`.
///
/// <p>Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p> <important>
/// <p>If you don't provide a value for an attribute, it will be set to the default value.</p>
/// </important>
/// <p>You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateUserPoolClient {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_user_pool_client_input::Builder,
}
impl UpdateUserPoolClient {
/// Creates a new `UpdateUserPoolClient`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateUserPoolClient,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateUserPoolClientError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateUserPoolClientOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateUserPoolClientError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The user pool ID for the user pool where you want to update the user pool client.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool where you want to update the user pool client.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn client_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_id(input.into());
self
}
/// <p>The ID of the client associated with the user pool.</p>
pub fn set_client_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_id(input);
self
}
/// <p>The client name from the update user pool client request.</p>
pub fn client_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_name(input.into());
self
}
/// <p>The client name from the update user pool client request.</p>
pub fn set_client_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_name(input);
self
}
/// <p>The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session and retrieve new access and ID tokens for 10 days.</p>
/// <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days. You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.</p>
pub fn refresh_token_validity(mut self, input: i32) -> Self {
self.inner = self.inner.refresh_token_validity(input);
self
}
/// <p>The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session and retrieve new access and ID tokens for 10 days.</p>
/// <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days. You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.</p>
pub fn set_refresh_token_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_refresh_token_validity(input);
self
}
/// <p>The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for <code>AccessTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with their access token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.</p>
pub fn access_token_validity(mut self, input: i32) -> Self {
self.inner = self.inner.access_token_validity(input);
self
}
/// <p>The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for <code>AccessTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with their access token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.</p>
pub fn set_access_token_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_access_token_validity(input);
self
}
/// <p>The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for <code>IdTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their session with their ID token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.</p>
pub fn id_token_validity(mut self, input: i32) -> Self {
self.inner = self.inner.id_token_validity(input);
self
}
/// <p>The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for <code>IdTokenValidity</code> as <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>, set a <code>TokenValidityUnits</code> value in your API request.</p>
/// <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their session with their ID token for 10 hours.</p>
/// <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours. <i>Valid range</i> is displayed below in seconds.</p>
/// <p>If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.</p>
pub fn set_id_token_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_id_token_validity(input);
self
}
/// <p>The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.</p>
pub fn token_validity_units(mut self, input: crate::model::TokenValidityUnitsType) -> Self {
self.inner = self.inner.token_validity_units(input);
self
}
/// <p>The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.</p>
pub fn set_token_validity_units(
mut self,
input: std::option::Option<crate::model::TokenValidityUnitsType>,
) -> Self {
self.inner = self.inner.set_token_validity_units(input);
self
}
/// Appends an item to `ReadAttributes`.
///
/// To override the contents of this collection use [`set_read_attributes`](Self::set_read_attributes).
///
/// <p>The read-only attributes of the user pool.</p>
pub fn read_attributes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.read_attributes(input.into());
self
}
/// <p>The read-only attributes of the user pool.</p>
pub fn set_read_attributes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_read_attributes(input);
self
}
/// Appends an item to `WriteAttributes`.
///
/// To override the contents of this collection use [`set_write_attributes`](Self::set_write_attributes).
///
/// <p>The writeable attributes of the user pool.</p>
pub fn write_attributes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.write_attributes(input.into());
self
}
/// <p>The writeable attributes of the user pool.</p>
pub fn set_write_attributes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_write_attributes(input);
self
}
/// Appends an item to `ExplicitAuthFlows`.
///
/// To override the contents of this collection use [`set_explicit_auth_flows`](Self::set_explicit_auth_flows).
///
/// <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.</p> <note>
/// <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p>
/// </note>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.</p> </li>
/// <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li>
/// <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li>
/// <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li>
/// <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li>
/// </ul>
/// <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>. You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>, like <code>ALLOW_USER_SRP_AUTH</code>.</p>
pub fn explicit_auth_flows(mut self, input: crate::model::ExplicitAuthFlowsType) -> Self {
self.inner = self.inner.explicit_auth_flows(input);
self
}
/// <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.</p> <note>
/// <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your user client supports <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.</p>
/// </note>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.</p> </li>
/// <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li>
/// <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li>
/// <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li>
/// <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li>
/// </ul>
/// <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>. You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>, like <code>ALLOW_USER_SRP_AUTH</code>.</p>
pub fn set_explicit_auth_flows(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::ExplicitAuthFlowsType>>,
) -> Self {
self.inner = self.inner.set_explicit_auth_flows(input);
self
}
/// Appends an item to `SupportedIdentityProviders`.
///
/// To override the contents of this collection use [`set_supported_identity_providers`](Self::set_supported_identity_providers).
///
/// <p>A list of provider names for the IdPs that this client supports. The following are supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>, <code>LoginWithAmazon</code>, and the names of your own SAML and OIDC providers.</p>
pub fn supported_identity_providers(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.supported_identity_providers(input.into());
self
}
/// <p>A list of provider names for the IdPs that this client supports. The following are supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>, <code>LoginWithAmazon</code>, and the names of your own SAML and OIDC providers.</p>
pub fn set_supported_identity_providers(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_supported_identity_providers(input);
self
}
/// Appends an item to `CallbackURLs`.
///
/// To override the contents of this collection use [`set_callback_ur_ls`](Self::set_callback_ur_ls).
///
/// <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
/// <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
pub fn callback_ur_ls(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.callback_ur_ls(input.into());
self
}
/// <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.</p>
/// <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
pub fn set_callback_ur_ls(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_callback_ur_ls(input);
self
}
/// Appends an item to `LogoutURLs`.
///
/// To override the contents of this collection use [`set_logout_ur_ls`](Self::set_logout_ur_ls).
///
/// <p>A list of allowed logout URLs for the IdPs.</p>
pub fn logout_ur_ls(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.logout_ur_ls(input.into());
self
}
/// <p>A list of allowed logout URLs for the IdPs.</p>
pub fn set_logout_ur_ls(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_logout_ur_ls(input);
self
}
/// <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing purposes only.</p>
/// <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
pub fn default_redirect_uri(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.default_redirect_uri(input.into());
self
}
/// <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
/// <p>A redirect URI must:</p>
/// <ul>
/// <li> <p>Be an absolute URI.</p> </li>
/// <li> <p>Be registered with the authorization server.</p> </li>
/// <li> <p>Not include a fragment component.</p> </li>
/// </ul>
/// <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 - Redirection Endpoint</a>.</p>
/// <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing purposes only.</p>
/// <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
pub fn set_default_redirect_uri(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_default_redirect_uri(input);
self
}
/// Appends an item to `AllowedOAuthFlows`.
///
/// To override the contents of this collection use [`set_allowed_o_auth_flows`](Self::set_allowed_o_auth_flows).
///
/// <p>The allowed OAuth flows.</p>
/// <dl>
/// <dt>
/// code
/// </dt>
/// <dd>
/// <p>Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the <code>/oauth2/token</code> endpoint.</p>
/// </dd>
/// <dt>
/// implicit
/// </dt>
/// <dd>
/// <p>Issue the access token (and, optionally, ID token, based on scopes) directly to your user.</p>
/// </dd>
/// <dt>
/// client_credentials
/// </dt>
/// <dd>
/// <p>Issue the access token from the <code>/oauth2/token</code> endpoint directly to a non-person user using a combination of the client ID and client secret.</p>
/// </dd>
/// </dl>
pub fn allowed_o_auth_flows(mut self, input: crate::model::OAuthFlowType) -> Self {
self.inner = self.inner.allowed_o_auth_flows(input);
self
}
/// <p>The allowed OAuth flows.</p>
/// <dl>
/// <dt>
/// code
/// </dt>
/// <dd>
/// <p>Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the <code>/oauth2/token</code> endpoint.</p>
/// </dd>
/// <dt>
/// implicit
/// </dt>
/// <dd>
/// <p>Issue the access token (and, optionally, ID token, based on scopes) directly to your user.</p>
/// </dd>
/// <dt>
/// client_credentials
/// </dt>
/// <dd>
/// <p>Issue the access token from the <code>/oauth2/token</code> endpoint directly to a non-person user using a combination of the client ID and client secret.</p>
/// </dd>
/// </dl>
pub fn set_allowed_o_auth_flows(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::OAuthFlowType>>,
) -> Self {
self.inner = self.inner.set_allowed_o_auth_flows(input);
self
}
/// Appends an item to `AllowedOAuthScopes`.
///
/// To override the contents of this collection use [`set_allowed_o_auth_scopes`](Self::set_allowed_o_auth_scopes).
///
/// <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>
pub fn allowed_o_auth_scopes(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.allowed_o_auth_scopes(input.into());
self
}
/// <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>
pub fn set_allowed_o_auth_scopes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_allowed_o_auth_scopes(input);
self
}
/// <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
pub fn allowed_o_auth_flows_user_pool_client(mut self, input: bool) -> Self {
self.inner = self.inner.allowed_o_auth_flows_user_pool_client(input);
self
}
/// <p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.</p>
pub fn set_allowed_o_auth_flows_user_pool_client(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.inner = self.inner.set_allowed_o_auth_flows_user_pool_client(input);
self
}
/// <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.</p> <note>
/// <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p>
/// </note>
pub fn analytics_configuration(
mut self,
input: crate::model::AnalyticsConfigurationType,
) -> Self {
self.inner = self.inner.analytics_configuration(input);
self
}
/// <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.</p> <note>
/// <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p>
/// </note>
pub fn set_analytics_configuration(
mut self,
input: std::option::Option<crate::model::AnalyticsConfigurationType>,
) -> Self {
self.inner = self.inner.set_analytics_configuration(input);
self
}
/// <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li>
/// <li> <p> <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.</p> </li>
/// </ul>
pub fn prevent_user_existence_errors(
mut self,
input: crate::model::PreventUserExistenceErrorTypes,
) -> Self {
self.inner = self.inner.prevent_user_existence_errors(input);
self
}
/// <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs return a <code>UserNotFoundException</code> exception if the user doesn't exist in the user pool.</p>
/// <p>Valid values include:</p>
/// <ul>
/// <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li>
/// <li> <p> <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.</p> </li>
/// </ul>
pub fn set_prevent_user_existence_errors(
mut self,
input: std::option::Option<crate::model::PreventUserExistenceErrorTypes>,
) -> Self {
self.inner = self.inner.set_prevent_user_existence_errors(input);
self
}
/// <p>Activates or deactivates token revocation. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
pub fn enable_token_revocation(mut self, input: bool) -> Self {
self.inner = self.inner.enable_token_revocation(input);
self
}
/// <p>Activates or deactivates token revocation. For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
pub fn set_enable_token_revocation(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_enable_token_revocation(input);
self
}
/// <p>Activates the propagation of additional user context data. For more information about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a client secret.</p>
pub fn enable_propagate_additional_user_context_data(mut self, input: bool) -> Self {
self.inner = self
.inner
.enable_propagate_additional_user_context_data(input);
self
}
/// <p>Activates the propagation of additional user context data. For more information about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a client secret.</p>
pub fn set_enable_propagate_additional_user_context_data(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.inner = self
.inner
.set_enable_propagate_additional_user_context_data(input);
self
}
/// <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
pub fn auth_session_validity(mut self, input: i32) -> Self {
self.inner = self.inner.auth_session_validity(input);
self
}
/// <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
pub fn set_auth_session_validity(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_auth_session_validity(input);
self
}
}
/// Fluent builder constructing a request to `UpdateUserPoolDomain`.
///
/// <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.</p>
/// <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
/// <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.</p>
/// <p>Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.</p>
/// <p>However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.</p>
/// <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.</p>
/// <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.</p>
/// <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateUserPoolDomain {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_user_pool_domain_input::Builder,
}
impl UpdateUserPoolDomain {
/// Creates a new `UpdateUserPoolDomain`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateUserPoolDomain,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateUserPoolDomainError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateUserPoolDomainOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateUserPoolDomainError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be <code>auth.example.com</code>. </p>
/// <p>This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be <code>auth.example.com</code>. </p>
/// <p>This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
/// <p>The ID of the user pool that is associated with the custom domain whose certificate you're updating.</p>
pub fn user_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The ID of the user pool that is associated with the custom domain whose certificate you're updating.</p>
pub fn set_user_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.</p>
pub fn custom_domain_config(mut self, input: crate::model::CustomDomainConfigType) -> Self {
self.inner = self.inner.custom_domain_config(input);
self
}
/// <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.</p>
pub fn set_custom_domain_config(
mut self,
input: std::option::Option<crate::model::CustomDomainConfigType>,
) -> Self {
self.inner = self.inner.set_custom_domain_config(input);
self
}
}
/// Fluent builder constructing a request to `VerifySoftwareToken`.
///
/// <p>Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct VerifySoftwareToken {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::verify_software_token_input::Builder,
}
impl VerifySoftwareToken {
/// Creates a new `VerifySoftwareToken`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::VerifySoftwareToken,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::VerifySoftwareTokenError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::VerifySoftwareTokenOutput,
aws_smithy_http::result::SdkError<crate::error::VerifySoftwareTokenError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose software token you want to verify.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose software token you want to verify.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service.</p>
pub fn session(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.session(input.into());
self
}
/// <p>The session that should be passed both ways in challenge-response calls to the service.</p>
pub fn set_session(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_session(input);
self
}
/// <p>The one- time password computed using the secret code returned by <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a>.</p>
pub fn user_code(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_code(input.into());
self
}
/// <p>The one- time password computed using the secret code returned by <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a>.</p>
pub fn set_user_code(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_code(input);
self
}
/// <p>The friendly device name.</p>
pub fn friendly_device_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.friendly_device_name(input.into());
self
}
/// <p>The friendly device name.</p>
pub fn set_friendly_device_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_friendly_device_name(input);
self
}
}
/// Fluent builder constructing a request to `VerifyUserAttribute`.
///
/// <p>Verifies the specified user attributes in the user pool.</p>
/// <p> If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html"> UserAttributeUpdateSettingsType</a>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct VerifyUserAttribute {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::verify_user_attribute_input::Builder,
}
impl VerifyUserAttribute {
/// Creates a new `VerifyUserAttribute`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::VerifyUserAttribute,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::VerifyUserAttributeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::VerifyUserAttributeOutput,
aws_smithy_http::result::SdkError<crate::error::VerifyUserAttributeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.</p>
pub fn access_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.access_token(input.into());
self
}
/// <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.</p>
pub fn set_access_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_access_token(input);
self
}
/// <p>The attribute name in the request to verify user attributes.</p>
pub fn attribute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.attribute_name(input.into());
self
}
/// <p>The attribute name in the request to verify user attributes.</p>
pub fn set_attribute_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_attribute_name(input);
self
}
/// <p>The verification code in the request to verify user attributes.</p>
pub fn code(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.code(input.into());
self
}
/// <p>The verification code in the request to verify user attributes.</p>
pub fn set_code(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_code(input);
self
}
}
}
impl Client {
/// Creates a new client from an [SDK Config](aws_types::sdk_config::SdkConfig).
///
/// # Panics
///
/// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
Self::from_conf(sdk_config.into())
}
/// Creates a new client from the service [`Config`](crate::Config).
///
/// # Panics
///
/// - This method will panic if the `conf` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `conf` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn from_conf(conf: crate::Config) -> Self {
let retry_config = conf
.retry_config()
.cloned()
.unwrap_or_else(aws_smithy_types::retry::RetryConfig::disabled);
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(aws_smithy_types::timeout::TimeoutConfig::disabled);
let sleep_impl = conf.sleep_impl();
if (retry_config.has_retry() || timeout_config.has_timeouts()) && sleep_impl.is_none() {
panic!("An async sleep implementation is required for retries or timeouts to work. \
Set the `sleep_impl` on the Config passed into this function to fix this panic.");
}
let connector = conf.http_connector().and_then(|c| {
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(aws_smithy_types::timeout::TimeoutConfig::disabled);
let connector_settings =
aws_smithy_client::http_connector::ConnectorSettings::from_timeout_config(
&timeout_config,
);
c.connector(&connector_settings, conf.sleep_impl())
});
let builder = aws_smithy_client::Builder::new();
let builder = match connector {
// Use provided connector
Some(c) => builder.connector(c),
None => {
#[cfg(any(feature = "rustls", feature = "native-tls"))]
{
// Use default connector based on enabled features
builder.dyn_https_connector(
aws_smithy_client::http_connector::ConnectorSettings::from_timeout_config(
&timeout_config,
),
)
}
#[cfg(not(any(feature = "rustls", feature = "native-tls")))]
{
panic!("No HTTP connector was available. Enable the `rustls` or `native-tls` crate feature or set a connector to fix this.");
}
}
};
let mut builder = builder
.middleware(aws_smithy_client::erase::DynMiddleware::new(
crate::middleware::DefaultMiddleware::new(),
))
.retry_config(retry_config.into())
.operation_timeout_config(timeout_config.into());
builder.set_sleep_impl(sleep_impl);
let client = builder.build();
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}