pub struct CognitoIdentityProviderClient { /* private fields */ }
Expand description
A client for the Amazon Cognito Identity Provider API.
Implementations
sourceimpl CognitoIdentityProviderClient
impl CognitoIdentityProviderClient
sourcepub fn new(region: Region) -> CognitoIdentityProviderClient
pub fn new(region: Region) -> CognitoIdentityProviderClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region
) -> CognitoIdentityProviderClient where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(
client: Client,
region: Region
) -> CognitoIdentityProviderClient
Trait Implementations
sourceimpl Clone for CognitoIdentityProviderClient
impl Clone for CognitoIdentityProviderClient
sourcefn clone(&self) -> CognitoIdentityProviderClient
fn clone(&self) -> CognitoIdentityProviderClient
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl CognitoIdentityProvider for CognitoIdentityProviderClient
impl CognitoIdentityProvider for CognitoIdentityProviderClient
sourcefn add_custom_attributes<'life0, 'async_trait>(
&'life0 self,
input: AddCustomAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<AddCustomAttributesResponse, RusotoError<AddCustomAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn add_custom_attributes<'life0, 'async_trait>(
&'life0 self,
input: AddCustomAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<AddCustomAttributesResponse, RusotoError<AddCustomAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Adds additional user attributes to the user pool schema.
sourcefn admin_add_user_to_group<'life0, 'async_trait>(
&'life0 self,
input: AdminAddUserToGroupRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminAddUserToGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_add_user_to_group<'life0, 'async_trait>(
&'life0 self,
input: AdminAddUserToGroupRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminAddUserToGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Adds the specified user to the specified group.
Calling this action requires developer credentials.
sourcefn admin_confirm_sign_up<'life0, 'async_trait>(
&'life0 self,
input: AdminConfirmSignUpRequest
) -> Pin<Box<dyn Future<Output = Result<AdminConfirmSignUpResponse, RusotoError<AdminConfirmSignUpError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_confirm_sign_up<'life0, 'async_trait>(
&'life0 self,
input: AdminConfirmSignUpRequest
) -> Pin<Box<dyn Future<Output = Result<AdminConfirmSignUpResponse, RusotoError<AdminConfirmSignUpError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
sourcefn admin_create_user<'life0, 'async_trait>(
&'life0 self,
input: AdminCreateUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminCreateUserResponse, RusotoError<AdminCreateUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_create_user<'life0, 'async_trait>(
&'life0 self,
input: AdminCreateUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminCreateUserResponse, RusotoError<AdminCreateUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a new user in the specified user pool.
If MessageAction
is not set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
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.
Alternatively, you can call AdminCreateUser
with “SUPPRESS” for the MessageAction
parameter, and Amazon Cognito will not send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD
state until they sign in and change their password.
AdminCreateUser
requires developer credentials.
sourcefn admin_delete_user<'life0, 'async_trait>(
&'life0 self,
input: AdminDeleteUserRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminDeleteUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_delete_user<'life0, 'async_trait>(
&'life0 self,
input: AdminDeleteUserRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminDeleteUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
sourcefn admin_delete_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: AdminDeleteUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<AdminDeleteUserAttributesResponse, RusotoError<AdminDeleteUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_delete_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: AdminDeleteUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<AdminDeleteUserAttributesResponse, RusotoError<AdminDeleteUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
sourcefn admin_disable_provider_for_user<'life0, 'async_trait>(
&'life0 self,
input: AdminDisableProviderForUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminDisableProviderForUserResponse, RusotoError<AdminDisableProviderForUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_disable_provider_for_user<'life0, 'async_trait>(
&'life0 self,
input: AdminDisableProviderForUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminDisableProviderForUserResponse, RusotoError<AdminDisableProviderForUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser
) signs in, they must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
The ProviderName
must match the value specified when creating an IdP for the pool.
To disable a native username + password user, the ProviderName
value must be Cognito
and the ProviderAttributeName
must be Cognito_Subject
, with the ProviderAttributeValue
being the name that is used in the user pool for the user.
The ProviderAttributeName
must always be Cognito_Subject
for social identity providers. The ProviderAttributeValue
must always be the exact subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName
and ProviderAttributeValue
must be the same values that were used for the SourceUser
when the identities were originally linked using AdminLinkProviderForUser
call. (If the linking was done with ProviderAttributeName
set to Cognito_Subject
, the same applies here). However, if the user has already signed in, the ProviderAttributeName
must be Cognito_Subject
and ProviderAttributeValue
must be the subject of the SAML assertion.
sourcefn admin_disable_user<'life0, 'async_trait>(
&'life0 self,
input: AdminDisableUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminDisableUserResponse, RusotoError<AdminDisableUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_disable_user<'life0, 'async_trait>(
&'life0 self,
input: AdminDisableUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminDisableUserResponse, RusotoError<AdminDisableUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Disables the specified user.
Calling this action requires developer credentials.
sourcefn admin_enable_user<'life0, 'async_trait>(
&'life0 self,
input: AdminEnableUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminEnableUserResponse, RusotoError<AdminEnableUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_enable_user<'life0, 'async_trait>(
&'life0 self,
input: AdminEnableUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminEnableUserResponse, RusotoError<AdminEnableUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
sourcefn admin_forget_device<'life0, 'async_trait>(
&'life0 self,
input: AdminForgetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminForgetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_forget_device<'life0, 'async_trait>(
&'life0 self,
input: AdminForgetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminForgetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Forgets the device, as an administrator.
Calling this action requires developer credentials.
sourcefn admin_get_device<'life0, 'async_trait>(
&'life0 self,
input: AdminGetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<AdminGetDeviceResponse, RusotoError<AdminGetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_get_device<'life0, 'async_trait>(
&'life0 self,
input: AdminGetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<AdminGetDeviceResponse, RusotoError<AdminGetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the device, as an administrator.
Calling this action requires developer credentials.
sourcefn admin_get_user<'life0, 'async_trait>(
&'life0 self,
input: AdminGetUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminGetUserResponse, RusotoError<AdminGetUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_get_user<'life0, 'async_trait>(
&'life0 self,
input: AdminGetUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminGetUserResponse, RusotoError<AdminGetUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
sourcefn admin_initiate_auth<'life0, 'async_trait>(
&'life0 self,
input: AdminInitiateAuthRequest
) -> Pin<Box<dyn Future<Output = Result<AdminInitiateAuthResponse, RusotoError<AdminInitiateAuthError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_initiate_auth<'life0, 'async_trait>(
&'life0 self,
input: AdminInitiateAuthRequest
) -> Pin<Box<dyn Future<Output = Result<AdminInitiateAuthResponse, RusotoError<AdminInitiateAuthError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Initiates the authentication flow, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
sourcefn admin_link_provider_for_user<'life0, 'async_trait>(
&'life0 self,
input: AdminLinkProviderForUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminLinkProviderForUserResponse, RusotoError<AdminLinkProviderForUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_link_provider_for_user<'life0, 'async_trait>(
&'life0 self,
input: AdminLinkProviderForUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminLinkProviderForUserResponse, RusotoError<AdminLinkProviderForUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Links an existing user account in a user pool (DestinationUser
) to an identity from an external identity provider (SourceUser
) based on a specified attribute name and value from the external identity provider. 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, so that the federated user identity can be used to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
The maximum number of federated identities linked to a user is 5.
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 identity providers and provider attributes that have been trusted by the application owner.
This action is enabled only for admin access and requires developer credentials.
sourcefn admin_list_devices<'life0, 'async_trait>(
&'life0 self,
input: AdminListDevicesRequest
) -> Pin<Box<dyn Future<Output = Result<AdminListDevicesResponse, RusotoError<AdminListDevicesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_list_devices<'life0, 'async_trait>(
&'life0 self,
input: AdminListDevicesRequest
) -> Pin<Box<dyn Future<Output = Result<AdminListDevicesResponse, RusotoError<AdminListDevicesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists devices, as an administrator.
Calling this action requires developer credentials.
sourcefn admin_list_groups_for_user<'life0, 'async_trait>(
&'life0 self,
input: AdminListGroupsForUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminListGroupsForUserResponse, RusotoError<AdminListGroupsForUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_list_groups_for_user<'life0, 'async_trait>(
&'life0 self,
input: AdminListGroupsForUserRequest
) -> Pin<Box<dyn Future<Output = Result<AdminListGroupsForUserResponse, RusotoError<AdminListGroupsForUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
sourcefn admin_list_user_auth_events<'life0, 'async_trait>(
&'life0 self,
input: AdminListUserAuthEventsRequest
) -> Pin<Box<dyn Future<Output = Result<AdminListUserAuthEventsResponse, RusotoError<AdminListUserAuthEventsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_list_user_auth_events<'life0, 'async_trait>(
&'life0 self,
input: AdminListUserAuthEventsRequest
) -> Pin<Box<dyn Future<Output = Result<AdminListUserAuthEventsResponse, RusotoError<AdminListUserAuthEventsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
sourcefn admin_remove_user_from_group<'life0, 'async_trait>(
&'life0 self,
input: AdminRemoveUserFromGroupRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminRemoveUserFromGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_remove_user_from_group<'life0, 'async_trait>(
&'life0 self,
input: AdminRemoveUserFromGroupRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<AdminRemoveUserFromGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Removes the specified user from the specified group.
Calling this action requires developer credentials.
sourcefn admin_reset_user_password<'life0, 'async_trait>(
&'life0 self,
input: AdminResetUserPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<AdminResetUserPasswordResponse, RusotoError<AdminResetUserPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_reset_user_password<'life0, 'async_trait>(
&'life0 self,
input: AdminResetUserPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<AdminResetUserPasswordResponse, RusotoError<AdminResetUserPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Resets the specified user's password in a user pool as an administrator. Works on any user.
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.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
sourcefn admin_respond_to_auth_challenge<'life0, 'async_trait>(
&'life0 self,
input: AdminRespondToAuthChallengeRequest
) -> Pin<Box<dyn Future<Output = Result<AdminRespondToAuthChallengeResponse, RusotoError<AdminRespondToAuthChallengeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_respond_to_auth_challenge<'life0, 'async_trait>(
&'life0 self,
input: AdminRespondToAuthChallengeRequest
) -> Pin<Box<dyn Future<Output = Result<AdminRespondToAuthChallengeResponse, RusotoError<AdminRespondToAuthChallengeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Responds to an authentication challenge, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
sourcefn admin_set_user_mfa_preference<'life0, 'async_trait>(
&'life0 self,
input: AdminSetUserMFAPreferenceRequest
) -> Pin<Box<dyn Future<Output = Result<AdminSetUserMFAPreferenceResponse, RusotoError<AdminSetUserMFAPreferenceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_set_user_mfa_preference<'life0, 'async_trait>(
&'life0 self,
input: AdminSetUserMFAPreferenceRequest
) -> Pin<Box<dyn Future<Output = Result<AdminSetUserMFAPreferenceResponse, RusotoError<AdminSetUserMFAPreferenceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled 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 enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
sourcefn admin_set_user_password<'life0, 'async_trait>(
&'life0 self,
input: AdminSetUserPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<AdminSetUserPasswordResponse, RusotoError<AdminSetUserPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_set_user_password<'life0, 'async_trait>(
&'life0 self,
input: AdminSetUserPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<AdminSetUserPasswordResponse, RusotoError<AdminSetUserPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED
challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.
Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed
.
sourcefn admin_set_user_settings<'life0, 'async_trait>(
&'life0 self,
input: AdminSetUserSettingsRequest
) -> Pin<Box<dyn Future<Output = Result<AdminSetUserSettingsResponse, RusotoError<AdminSetUserSettingsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_set_user_settings<'life0, 'async_trait>(
&'life0 self,
input: AdminSetUserSettingsRequest
) -> Pin<Box<dyn Future<Output = Result<AdminSetUserSettingsResponse, RusotoError<AdminSetUserSettingsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
sourcefn admin_update_auth_event_feedback<'life0, 'async_trait>(
&'life0 self,
input: AdminUpdateAuthEventFeedbackRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUpdateAuthEventFeedbackResponse, RusotoError<AdminUpdateAuthEventFeedbackError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_update_auth_event_feedback<'life0, 'async_trait>(
&'life0 self,
input: AdminUpdateAuthEventFeedbackRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUpdateAuthEventFeedbackResponse, RusotoError<AdminUpdateAuthEventFeedbackError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Provides feedback for an authentication event as to whether 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.
sourcefn admin_update_device_status<'life0, 'async_trait>(
&'life0 self,
input: AdminUpdateDeviceStatusRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUpdateDeviceStatusResponse, RusotoError<AdminUpdateDeviceStatusError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_update_device_status<'life0, 'async_trait>(
&'life0 self,
input: AdminUpdateDeviceStatusRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUpdateDeviceStatusResponse, RusotoError<AdminUpdateDeviceStatusError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the device status as an administrator.
Calling this action requires developer credentials.
sourcefn admin_update_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: AdminUpdateUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUpdateUserAttributesResponse, RusotoError<AdminUpdateUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_update_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: AdminUpdateUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUpdateUserAttributesResponse, RusotoError<AdminUpdateUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
sourcefn admin_user_global_sign_out<'life0, 'async_trait>(
&'life0 self,
input: AdminUserGlobalSignOutRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUserGlobalSignOutResponse, RusotoError<AdminUserGlobalSignOutError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn admin_user_global_sign_out<'life0, 'async_trait>(
&'life0 self,
input: AdminUserGlobalSignOutRequest
) -> Pin<Box<dyn Future<Output = Result<AdminUserGlobalSignOutResponse, RusotoError<AdminUserGlobalSignOutError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
sourcefn associate_software_token<'life0, 'async_trait>(
&'life0 self,
input: AssociateSoftwareTokenRequest
) -> Pin<Box<dyn Future<Output = Result<AssociateSoftwareTokenResponse, RusotoError<AssociateSoftwareTokenError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn associate_software_token<'life0, 'async_trait>(
&'life0 self,
input: AssociateSoftwareTokenRequest
) -> Pin<Box<dyn Future<Output = Result<AssociateSoftwareTokenResponse, RusotoError<AssociateSoftwareTokenError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token, their account is essentially set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then login without MFA. However, if MFA is set to Required for the user pool, the user will be asked to setup a new software token MFA during sign in.
sourcefn change_password<'life0, 'async_trait>(
&'life0 self,
input: ChangePasswordRequest
) -> Pin<Box<dyn Future<Output = Result<ChangePasswordResponse, RusotoError<ChangePasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn change_password<'life0, 'async_trait>(
&'life0 self,
input: ChangePasswordRequest
) -> Pin<Box<dyn Future<Output = Result<ChangePasswordResponse, RusotoError<ChangePasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Changes the password for a specified user in a user pool.
sourcefn confirm_device<'life0, 'async_trait>(
&'life0 self,
input: ConfirmDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<ConfirmDeviceResponse, RusotoError<ConfirmDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn confirm_device<'life0, 'async_trait>(
&'life0 self,
input: ConfirmDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<ConfirmDeviceResponse, RusotoError<ConfirmDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Confirms tracking of the device. This API call is the call that begins device tracking.
sourcefn confirm_forgot_password<'life0, 'async_trait>(
&'life0 self,
input: ConfirmForgotPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<ConfirmForgotPasswordResponse, RusotoError<ConfirmForgotPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn confirm_forgot_password<'life0, 'async_trait>(
&'life0 self,
input: ConfirmForgotPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<ConfirmForgotPasswordResponse, RusotoError<ConfirmForgotPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Allows a user to enter a confirmation code to reset a forgotten password.
sourcefn confirm_sign_up<'life0, 'async_trait>(
&'life0 self,
input: ConfirmSignUpRequest
) -> Pin<Box<dyn Future<Output = Result<ConfirmSignUpResponse, RusotoError<ConfirmSignUpError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn confirm_sign_up<'life0, 'async_trait>(
&'life0 self,
input: ConfirmSignUpRequest
) -> Pin<Box<dyn Future<Output = Result<ConfirmSignUpResponse, RusotoError<ConfirmSignUpError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Confirms registration of a user and handles the existing alias from a previous user.
sourcefn create_group<'life0, 'async_trait>(
&'life0 self,
input: CreateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<CreateGroupResponse, RusotoError<CreateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_group<'life0, 'async_trait>(
&'life0 self,
input: CreateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<CreateGroupResponse, RusotoError<CreateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
sourcefn create_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: CreateIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<CreateIdentityProviderResponse, RusotoError<CreateIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: CreateIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<CreateIdentityProviderResponse, RusotoError<CreateIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates an identity provider for a user pool.
sourcefn create_resource_server<'life0, 'async_trait>(
&'life0 self,
input: CreateResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<CreateResourceServerResponse, RusotoError<CreateResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_resource_server<'life0, 'async_trait>(
&'life0 self,
input: CreateResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<CreateResourceServerResponse, RusotoError<CreateResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a new OAuth2.0 resource server and defines custom scopes in it.
sourcefn create_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: CreateUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserImportJobResponse, RusotoError<CreateUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: CreateUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserImportJobResponse, RusotoError<CreateUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates the user import job.
sourcefn create_user_pool<'life0, 'async_trait>(
&'life0 self,
input: CreateUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserPoolResponse, RusotoError<CreateUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_user_pool<'life0, 'async_trait>(
&'life0 self,
input: CreateUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserPoolResponse, RusotoError<CreateUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn create_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: CreateUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserPoolClientResponse, RusotoError<CreateUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: CreateUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserPoolClientResponse, RusotoError<CreateUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates the user pool client.
When you create a new user pool client, token revocation is automatically enabled. For more information about revoking tokens, see RevokeToken.
sourcefn create_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: CreateUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserPoolDomainResponse, RusotoError<CreateUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: CreateUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserPoolDomainResponse, RusotoError<CreateUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a new domain for a user pool.
sourcefn delete_group<'life0, 'async_trait>(
&'life0 self,
input: DeleteGroupRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_group<'life0, 'async_trait>(
&'life0 self,
input: DeleteGroupRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a group.
Calling this action requires developer credentials.
sourcefn delete_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: DeleteIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: DeleteIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes an identity provider for a user pool.
sourcefn delete_resource_server<'life0, 'async_trait>(
&'life0 self,
input: DeleteResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_resource_server<'life0, 'async_trait>(
&'life0 self,
input: DeleteResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a resource server.
sourcefn delete_user<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_user<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Allows a user to delete himself or herself.
sourcefn delete_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteUserAttributesResponse, RusotoError<DeleteUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteUserAttributesResponse, RusotoError<DeleteUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes the attributes for a user.
sourcefn delete_user_pool<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_user_pool<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes the specified Amazon Cognito user pool.
sourcefn delete_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Allows the developer to delete the user pool client.
sourcefn delete_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteUserPoolDomainResponse, RusotoError<DeleteUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: DeleteUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteUserPoolDomainResponse, RusotoError<DeleteUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a domain for a user pool.
sourcefn describe_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: DescribeIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeIdentityProviderResponse, RusotoError<DescribeIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: DescribeIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeIdentityProviderResponse, RusotoError<DescribeIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets information about a specific identity provider.
sourcefn describe_resource_server<'life0, 'async_trait>(
&'life0 self,
input: DescribeResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeResourceServerResponse, RusotoError<DescribeResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_resource_server<'life0, 'async_trait>(
&'life0 self,
input: DescribeResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeResourceServerResponse, RusotoError<DescribeResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes a resource server.
sourcefn describe_risk_configuration<'life0, 'async_trait>(
&'life0 self,
input: DescribeRiskConfigurationRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeRiskConfigurationResponse, RusotoError<DescribeRiskConfigurationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_risk_configuration<'life0, 'async_trait>(
&'life0 self,
input: DescribeRiskConfigurationRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeRiskConfigurationResponse, RusotoError<DescribeRiskConfigurationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes the risk configuration.
sourcefn describe_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserImportJobResponse, RusotoError<DescribeUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserImportJobResponse, RusotoError<DescribeUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes the user import job.
sourcefn describe_user_pool<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserPoolResponse, RusotoError<DescribeUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_user_pool<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserPoolResponse, RusotoError<DescribeUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Returns the configuration information and metadata of the specified user pool.
sourcefn describe_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserPoolClientResponse, RusotoError<DescribeUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserPoolClientResponse, RusotoError<DescribeUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Client method for returning the configuration information and metadata of the specified user pool app client.
sourcefn describe_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserPoolDomainResponse, RusotoError<DescribeUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: DescribeUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserPoolDomainResponse, RusotoError<DescribeUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets information about a domain.
sourcefn forget_device<'life0, 'async_trait>(
&'life0 self,
input: ForgetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ForgetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn forget_device<'life0, 'async_trait>(
&'life0 self,
input: ForgetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ForgetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Forgets the specified device.
sourcefn forgot_password<'life0, 'async_trait>(
&'life0 self,
input: ForgotPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<ForgotPasswordResponse, RusotoError<ForgotPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn forgot_password<'life0, 'async_trait>(
&'life0 self,
input: ForgotPasswordRequest
) -> Pin<Box<dyn Future<Output = Result<ForgotPasswordResponse, RusotoError<ForgotPasswordError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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 Username
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 Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException
is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn get_csv_header<'life0, 'async_trait>(
&'life0 self,
input: GetCSVHeaderRequest
) -> Pin<Box<dyn Future<Output = Result<GetCSVHeaderResponse, RusotoError<GetCSVHeaderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_csv_header<'life0, 'async_trait>(
&'life0 self,
input: GetCSVHeaderRequest
) -> Pin<Box<dyn Future<Output = Result<GetCSVHeaderResponse, RusotoError<GetCSVHeaderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the header information for the .csv file to be used as input for the user import job.
sourcefn get_device<'life0, 'async_trait>(
&'life0 self,
input: GetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<GetDeviceResponse, RusotoError<GetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_device<'life0, 'async_trait>(
&'life0 self,
input: GetDeviceRequest
) -> Pin<Box<dyn Future<Output = Result<GetDeviceResponse, RusotoError<GetDeviceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the device.
sourcefn get_group<'life0, 'async_trait>(
&'life0 self,
input: GetGroupRequest
) -> Pin<Box<dyn Future<Output = Result<GetGroupResponse, RusotoError<GetGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_group<'life0, 'async_trait>(
&'life0 self,
input: GetGroupRequest
) -> Pin<Box<dyn Future<Output = Result<GetGroupResponse, RusotoError<GetGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets a group.
Calling this action requires developer credentials.
sourcefn get_identity_provider_by_identifier<'life0, 'async_trait>(
&'life0 self,
input: GetIdentityProviderByIdentifierRequest
) -> Pin<Box<dyn Future<Output = Result<GetIdentityProviderByIdentifierResponse, RusotoError<GetIdentityProviderByIdentifierError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_identity_provider_by_identifier<'life0, 'async_trait>(
&'life0 self,
input: GetIdentityProviderByIdentifierRequest
) -> Pin<Box<dyn Future<Output = Result<GetIdentityProviderByIdentifierResponse, RusotoError<GetIdentityProviderByIdentifierError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the specified identity provider.
sourcefn get_signing_certificate<'life0, 'async_trait>(
&'life0 self,
input: GetSigningCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<GetSigningCertificateResponse, RusotoError<GetSigningCertificateError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_signing_certificate<'life0, 'async_trait>(
&'life0 self,
input: GetSigningCertificateRequest
) -> Pin<Box<dyn Future<Output = Result<GetSigningCertificateResponse, RusotoError<GetSigningCertificateError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
This method takes a user pool ID, and returns the signing certificate.
sourcefn get_ui_customization<'life0, 'async_trait>(
&'life0 self,
input: GetUICustomizationRequest
) -> Pin<Box<dyn Future<Output = Result<GetUICustomizationResponse, RusotoError<GetUICustomizationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_ui_customization<'life0, 'async_trait>(
&'life0 self,
input: GetUICustomizationRequest
) -> Pin<Box<dyn Future<Output = Result<GetUICustomizationResponse, RusotoError<GetUICustomizationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId
will be ALL
), then that is returned. If nothing is present, then an empty shape is returned.
sourcefn get_user<'life0, 'async_trait>(
&'life0 self,
input: GetUserRequest
) -> Pin<Box<dyn Future<Output = Result<GetUserResponse, RusotoError<GetUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_user<'life0, 'async_trait>(
&'life0 self,
input: GetUserRequest
) -> Pin<Box<dyn Future<Output = Result<GetUserResponse, RusotoError<GetUserError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the user attributes and metadata for a user.
sourcefn get_user_attribute_verification_code<'life0, 'async_trait>(
&'life0 self,
input: GetUserAttributeVerificationCodeRequest
) -> Pin<Box<dyn Future<Output = Result<GetUserAttributeVerificationCodeResponse, RusotoError<GetUserAttributeVerificationCodeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_user_attribute_verification_code<'life0, 'async_trait>(
&'life0 self,
input: GetUserAttributeVerificationCodeRequest
) -> Pin<Box<dyn Future<Output = Result<GetUserAttributeVerificationCodeResponse, RusotoError<GetUserAttributeVerificationCodeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the user attribute verification code for the specified attribute name.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn get_user_pool_mfa_config<'life0, 'async_trait>(
&'life0 self,
input: GetUserPoolMfaConfigRequest
) -> Pin<Box<dyn Future<Output = Result<GetUserPoolMfaConfigResponse, RusotoError<GetUserPoolMfaConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_user_pool_mfa_config<'life0, 'async_trait>(
&'life0 self,
input: GetUserPoolMfaConfigRequest
) -> Pin<Box<dyn Future<Output = Result<GetUserPoolMfaConfigResponse, RusotoError<GetUserPoolMfaConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Gets the user pool multi-factor authentication (MFA) configuration.
sourcefn global_sign_out<'life0, 'async_trait>(
&'life0 self,
input: GlobalSignOutRequest
) -> Pin<Box<dyn Future<Output = Result<GlobalSignOutResponse, RusotoError<GlobalSignOutError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn global_sign_out<'life0, 'async_trait>(
&'life0 self,
input: GlobalSignOutRequest
) -> Pin<Box<dyn Future<Output = Result<GlobalSignOutResponse, RusotoError<GlobalSignOutError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
sourcefn initiate_auth<'life0, 'async_trait>(
&'life0 self,
input: InitiateAuthRequest
) -> Pin<Box<dyn Future<Output = Result<InitiateAuthResponse, RusotoError<InitiateAuthError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn initiate_auth<'life0, 'async_trait>(
&'life0 self,
input: InitiateAuthRequest
) -> Pin<Box<dyn Future<Output = Result<InitiateAuthResponse, RusotoError<InitiateAuthError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Initiates the authentication flow.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn list_devices<'life0, 'async_trait>(
&'life0 self,
input: ListDevicesRequest
) -> Pin<Box<dyn Future<Output = Result<ListDevicesResponse, RusotoError<ListDevicesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_devices<'life0, 'async_trait>(
&'life0 self,
input: ListDevicesRequest
) -> Pin<Box<dyn Future<Output = Result<ListDevicesResponse, RusotoError<ListDevicesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the devices.
sourcefn list_groups<'life0, 'async_trait>(
&'life0 self,
input: ListGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<ListGroupsResponse, RusotoError<ListGroupsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_groups<'life0, 'async_trait>(
&'life0 self,
input: ListGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<ListGroupsResponse, RusotoError<ListGroupsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
sourcefn list_identity_providers<'life0, 'async_trait>(
&'life0 self,
input: ListIdentityProvidersRequest
) -> Pin<Box<dyn Future<Output = Result<ListIdentityProvidersResponse, RusotoError<ListIdentityProvidersError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_identity_providers<'life0, 'async_trait>(
&'life0 self,
input: ListIdentityProvidersRequest
) -> Pin<Box<dyn Future<Output = Result<ListIdentityProvidersResponse, RusotoError<ListIdentityProvidersError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists information about all identity providers for a user pool.
sourcefn list_resource_servers<'life0, 'async_trait>(
&'life0 self,
input: ListResourceServersRequest
) -> Pin<Box<dyn Future<Output = Result<ListResourceServersResponse, RusotoError<ListResourceServersError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_resource_servers<'life0, 'async_trait>(
&'life0 self,
input: ListResourceServersRequest
) -> Pin<Box<dyn Future<Output = Result<ListResourceServersResponse, RusotoError<ListResourceServersError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the resource servers for a user pool.
Lists the tags that are assigned to an Amazon Cognito user pool.
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.
You can use this action up to 10 times per second, per account.
sourcefn list_user_import_jobs<'life0, 'async_trait>(
&'life0 self,
input: ListUserImportJobsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserImportJobsResponse, RusotoError<ListUserImportJobsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_user_import_jobs<'life0, 'async_trait>(
&'life0 self,
input: ListUserImportJobsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserImportJobsResponse, RusotoError<ListUserImportJobsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the user import jobs.
sourcefn list_user_pool_clients<'life0, 'async_trait>(
&'life0 self,
input: ListUserPoolClientsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserPoolClientsResponse, RusotoError<ListUserPoolClientsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_user_pool_clients<'life0, 'async_trait>(
&'life0 self,
input: ListUserPoolClientsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserPoolClientsResponse, RusotoError<ListUserPoolClientsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the clients that have been created for the specified user pool.
sourcefn list_user_pools<'life0, 'async_trait>(
&'life0 self,
input: ListUserPoolsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserPoolsResponse, RusotoError<ListUserPoolsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_user_pools<'life0, 'async_trait>(
&'life0 self,
input: ListUserPoolsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserPoolsResponse, RusotoError<ListUserPoolsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the user pools associated with an AWS account.
sourcefn list_users<'life0, 'async_trait>(
&'life0 self,
input: ListUsersRequest
) -> Pin<Box<dyn Future<Output = Result<ListUsersResponse, RusotoError<ListUsersError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_users<'life0, 'async_trait>(
&'life0 self,
input: ListUsersRequest
) -> Pin<Box<dyn Future<Output = Result<ListUsersResponse, RusotoError<ListUsersError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the users in the Amazon Cognito user pool.
sourcefn list_users_in_group<'life0, 'async_trait>(
&'life0 self,
input: ListUsersInGroupRequest
) -> Pin<Box<dyn Future<Output = Result<ListUsersInGroupResponse, RusotoError<ListUsersInGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_users_in_group<'life0, 'async_trait>(
&'life0 self,
input: ListUsersInGroupRequest
) -> Pin<Box<dyn Future<Output = Result<ListUsersInGroupResponse, RusotoError<ListUsersInGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the users in the specified group.
Calling this action requires developer credentials.
sourcefn resend_confirmation_code<'life0, 'async_trait>(
&'life0 self,
input: ResendConfirmationCodeRequest
) -> Pin<Box<dyn Future<Output = Result<ResendConfirmationCodeResponse, RusotoError<ResendConfirmationCodeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn resend_confirmation_code<'life0, 'async_trait>(
&'life0 self,
input: ResendConfirmationCodeRequest
) -> Pin<Box<dyn Future<Output = Result<ResendConfirmationCodeResponse, RusotoError<ResendConfirmationCodeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn respond_to_auth_challenge<'life0, 'async_trait>(
&'life0 self,
input: RespondToAuthChallengeRequest
) -> Pin<Box<dyn Future<Output = Result<RespondToAuthChallengeResponse, RusotoError<RespondToAuthChallengeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn respond_to_auth_challenge<'life0, 'async_trait>(
&'life0 self,
input: RespondToAuthChallengeRequest
) -> Pin<Box<dyn Future<Output = Result<RespondToAuthChallengeResponse, RusotoError<RespondToAuthChallengeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Responds to the authentication challenge.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn revoke_token<'life0, 'async_trait>(
&'life0 self,
input: RevokeTokenRequest
) -> Pin<Box<dyn Future<Output = Result<RevokeTokenResponse, RusotoError<RevokeTokenError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn revoke_token<'life0, 'async_trait>(
&'life0 self,
input: RevokeTokenRequest
) -> Pin<Box<dyn Future<Output = Result<RevokeTokenResponse, RusotoError<RevokeTokenError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can not use the revoked token to access Cognito authenticated APIs.
sourcefn set_risk_configuration<'life0, 'async_trait>(
&'life0 self,
input: SetRiskConfigurationRequest
) -> Pin<Box<dyn Future<Output = Result<SetRiskConfigurationResponse, RusotoError<SetRiskConfigurationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn set_risk_configuration<'life0, 'async_trait>(
&'life0 self,
input: SetRiskConfigurationRequest
) -> Pin<Box<dyn Future<Output = Result<SetRiskConfigurationResponse, RusotoError<SetRiskConfigurationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Configures actions on detected risks. To delete the risk configuration for UserPoolId
or ClientId
, pass null values for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns
keyAdvancedSecurityMode
.
sourcefn set_ui_customization<'life0, 'async_trait>(
&'life0 self,
input: SetUICustomizationRequest
) -> Pin<Box<dyn Future<Output = Result<SetUICustomizationResponse, RusotoError<SetUICustomizationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn set_ui_customization<'life0, 'async_trait>(
&'life0 self,
input: SetUICustomizationRequest
) -> Pin<Box<dyn Future<Output = Result<SetUICustomizationResponse, RusotoError<SetUICustomizationError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Sets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId
) or for all clients (by setting the clientId
to ALL
). If you specify ALL
, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL
configuration.
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.
sourcefn set_user_mfa_preference<'life0, 'async_trait>(
&'life0 self,
input: SetUserMFAPreferenceRequest
) -> Pin<Box<dyn Future<Output = Result<SetUserMFAPreferenceResponse, RusotoError<SetUserMFAPreferenceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn set_user_mfa_preference<'life0, 'async_trait>(
&'life0 self,
input: SetUserMFAPreferenceRequest
) -> Pin<Box<dyn Future<Output = Result<SetUserMFAPreferenceResponse, RusotoError<SetUserMFAPreferenceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled 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 enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in. If an MFA type is enabled 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 would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.
sourcefn set_user_pool_mfa_config<'life0, 'async_trait>(
&'life0 self,
input: SetUserPoolMfaConfigRequest
) -> Pin<Box<dyn Future<Output = Result<SetUserPoolMfaConfigResponse, RusotoError<SetUserPoolMfaConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn set_user_pool_mfa_config<'life0, 'async_trait>(
&'life0 self,
input: SetUserPoolMfaConfigRequest
) -> Pin<Box<dyn Future<Output = Result<SetUserPoolMfaConfigResponse, RusotoError<SetUserPoolMfaConfigError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Set the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn set_user_settings<'life0, 'async_trait>(
&'life0 self,
input: SetUserSettingsRequest
) -> Pin<Box<dyn Future<Output = Result<SetUserSettingsResponse, RusotoError<SetUserSettingsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn set_user_settings<'life0, 'async_trait>(
&'life0 self,
input: SetUserSettingsRequest
) -> Pin<Box<dyn Future<Output = Result<SetUserSettingsResponse, RusotoError<SetUserSettingsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
sourcefn sign_up<'life0, 'async_trait>(
&'life0 self,
input: SignUpRequest
) -> Pin<Box<dyn Future<Output = Result<SignUpResponse, RusotoError<SignUpError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn sign_up<'life0, 'async_trait>(
&'life0 self,
input: SignUpRequest
) -> Pin<Box<dyn Future<Output = Result<SignUpResponse, RusotoError<SignUpError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Registers the user in the specified user pool and creates a user name, password, and user attributes.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn start_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: StartUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<StartUserImportJobResponse, RusotoError<StartUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn start_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: StartUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<StartUserImportJobResponse, RusotoError<StartUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Starts the user import.
sourcefn stop_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: StopUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<StopUserImportJobResponse, RusotoError<StopUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn stop_user_import_job<'life0, 'async_trait>(
&'life0 self,
input: StopUserImportJobRequest
) -> Pin<Box<dyn Future<Output = Result<StopUserImportJobResponse, RusotoError<StopUserImportJobError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Stops the user import job.
sourcefn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
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 Environment
tag key to both user pools. The value of this key might be Test
for one user pool and Production
for the other.
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 IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
sourcefn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
sourcefn update_auth_event_feedback<'life0, 'async_trait>(
&'life0 self,
input: UpdateAuthEventFeedbackRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateAuthEventFeedbackResponse, RusotoError<UpdateAuthEventFeedbackError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_auth_event_feedback<'life0, 'async_trait>(
&'life0 self,
input: UpdateAuthEventFeedbackRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateAuthEventFeedbackResponse, RusotoError<UpdateAuthEventFeedbackError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn update_device_status<'life0, 'async_trait>(
&'life0 self,
input: UpdateDeviceStatusRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateDeviceStatusResponse, RusotoError<UpdateDeviceStatusError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_device_status<'life0, 'async_trait>(
&'life0 self,
input: UpdateDeviceStatusRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateDeviceStatusResponse, RusotoError<UpdateDeviceStatusError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the device status.
sourcefn update_group<'life0, 'async_trait>(
&'life0 self,
input: UpdateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateGroupResponse, RusotoError<UpdateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_group<'life0, 'async_trait>(
&'life0 self,
input: UpdateGroupRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateGroupResponse, RusotoError<UpdateGroupError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
sourcefn update_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: UpdateIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateIdentityProviderResponse, RusotoError<UpdateIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_identity_provider<'life0, 'async_trait>(
&'life0 self,
input: UpdateIdentityProviderRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateIdentityProviderResponse, RusotoError<UpdateIdentityProviderError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates identity provider information for a user pool.
sourcefn update_resource_server<'life0, 'async_trait>(
&'life0 self,
input: UpdateResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateResourceServerResponse, RusotoError<UpdateResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_resource_server<'life0, 'async_trait>(
&'life0 self,
input: UpdateResourceServerRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateResourceServerResponse, RusotoError<UpdateResourceServerError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it will be set to the default value.
sourcefn update_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserAttributesResponse, RusotoError<UpdateUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_user_attributes<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserAttributesResponse, RusotoError<UpdateUserAttributesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Allows a user to update a specific attribute (one at a time).
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn update_user_pool<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserPoolResponse, RusotoError<UpdateUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_user_pool<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserPoolRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserPoolResponse, RusotoError<UpdateUserPoolError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.
This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
sourcefn update_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserPoolClientResponse, RusotoError<UpdateUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_user_pool_client<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserPoolClientRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserPoolClientResponse, RusotoError<UpdateUserPoolClientError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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 DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
sourcefn update_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserPoolDomainResponse, RusotoError<UpdateUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_user_pool_domain<'life0, 'async_trait>(
&'life0 self,
input: UpdateUserPoolDomainRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateUserPoolDomainResponse, RusotoError<UpdateUserPoolDomainError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
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 AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
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.
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.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
sourcefn verify_software_token<'life0, 'async_trait>(
&'life0 self,
input: VerifySoftwareTokenRequest
) -> Pin<Box<dyn Future<Output = Result<VerifySoftwareTokenResponse, RusotoError<VerifySoftwareTokenError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn verify_software_token<'life0, 'async_trait>(
&'life0 self,
input: VerifySoftwareTokenRequest
) -> Pin<Box<dyn Future<Output = Result<VerifySoftwareTokenResponse, RusotoError<VerifySoftwareTokenError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Use this API to register a user's entered 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.
sourcefn verify_user_attribute<'life0, 'async_trait>(
&'life0 self,
input: VerifyUserAttributeRequest
) -> Pin<Box<dyn Future<Output = Result<VerifyUserAttributeResponse, RusotoError<VerifyUserAttributeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn verify_user_attribute<'life0, 'async_trait>(
&'life0 self,
input: VerifyUserAttributeRequest
) -> Pin<Box<dyn Future<Output = Result<VerifyUserAttributeResponse, RusotoError<VerifyUserAttributeError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Verifies the specified user attributes in the user pool.
Auto Trait Implementations
impl !RefUnwindSafe for CognitoIdentityProviderClient
impl Send for CognitoIdentityProviderClient
impl Sync for CognitoIdentityProviderClient
impl Unpin for CognitoIdentityProviderClient
impl !UnwindSafe for CognitoIdentityProviderClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more