& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminConfirmSignUp, request, handler, context);
}
/**
* Creates a new user in the specified user pool.
If
* MessageAction
isn't 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, 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 Amazon
* Pinpoint. 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.
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
* sandbox
* mode , 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
* SMS message settings for Amazon 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 won't 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.
See Also:
AWS
* API Reference
*/
virtual Model::AdminCreateUserOutcome AdminCreateUser(const Model::AdminCreateUserRequest& request) const;
/**
* A Callable wrapper for AdminCreateUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminCreateUserOutcomeCallable AdminCreateUserCallable(const AdminCreateUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminCreateUser, request);
}
/**
* An Async wrapper for AdminCreateUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminCreateUserAsync(const AdminCreateUserRequestT& request, const AdminCreateUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminCreateUser, request, handler, context);
}
/**
* Deletes a user as an administrator. Works on any user.
Calling this
* action requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminDeleteUserOutcome AdminDeleteUser(const Model::AdminDeleteUserRequest& request) const;
/**
* A Callable wrapper for AdminDeleteUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminDeleteUserOutcomeCallable AdminDeleteUserCallable(const AdminDeleteUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminDeleteUser, request);
}
/**
* An Async wrapper for AdminDeleteUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminDeleteUserAsync(const AdminDeleteUserRequestT& request, const AdminDeleteUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminDeleteUser, request, handler, context);
}
/**
* Deletes the user attributes in a user pool as an administrator. Works on any
* user.
Calling this action requires developer credentials.
See
* Also:
AWS
* API Reference
*/
virtual Model::AdminDeleteUserAttributesOutcome AdminDeleteUserAttributes(const Model::AdminDeleteUserAttributesRequest& request) const;
/**
* A Callable wrapper for AdminDeleteUserAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminDeleteUserAttributesOutcomeCallable AdminDeleteUserAttributesCallable(const AdminDeleteUserAttributesRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminDeleteUserAttributes, request);
}
/**
* An Async wrapper for AdminDeleteUserAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminDeleteUserAttributesAsync(const AdminDeleteUserAttributesRequestT& request, const AdminDeleteUserAttributesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminDeleteUserAttributes, request, handler, context);
}
/**
* 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
* DestinationUser
, the user 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 deactivate a native username +
* password user, the ProviderName
value must be Cognito
* and the ProviderAttributeName
must be Cognito_Subject
.
* The ProviderAttributeValue
must be the name that is used in the
* user pool for the user.
The ProviderAttributeName
must
* always be Cognito_Subject
for social IdPs. 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.
See Also:
AWS
* API Reference
*/
virtual Model::AdminDisableProviderForUserOutcome AdminDisableProviderForUser(const Model::AdminDisableProviderForUserRequest& request) const;
/**
* A Callable wrapper for AdminDisableProviderForUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminDisableProviderForUserOutcomeCallable AdminDisableProviderForUserCallable(const AdminDisableProviderForUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminDisableProviderForUser, request);
}
/**
* An Async wrapper for AdminDisableProviderForUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminDisableProviderForUserAsync(const AdminDisableProviderForUserRequestT& request, const AdminDisableProviderForUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminDisableProviderForUser, request, handler, context);
}
/**
* 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 GetUser
* and ListUsers
API requests.
You must make this API request
* with Amazon Web Services credentials that have
* cognito-idp:AdminDisableUser
permissions.
See Also:
* AWS
* API Reference
*/
virtual Model::AdminDisableUserOutcome AdminDisableUser(const Model::AdminDisableUserRequest& request) const;
/**
* A Callable wrapper for AdminDisableUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminDisableUserOutcomeCallable AdminDisableUserCallable(const AdminDisableUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminDisableUser, request);
}
/**
* An Async wrapper for AdminDisableUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminDisableUserAsync(const AdminDisableUserRequestT& request, const AdminDisableUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminDisableUser, request, handler, context);
}
/**
* Enables the specified user as an administrator. Works on any user.
* Calling this action requires developer credentials.
See Also:
* AWS
* API Reference
*/
virtual Model::AdminEnableUserOutcome AdminEnableUser(const Model::AdminEnableUserRequest& request) const;
/**
* A Callable wrapper for AdminEnableUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminEnableUserOutcomeCallable AdminEnableUserCallable(const AdminEnableUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminEnableUser, request);
}
/**
* An Async wrapper for AdminEnableUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminEnableUserAsync(const AdminEnableUserRequestT& request, const AdminEnableUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminEnableUser, request, handler, context);
}
/**
* Forgets the device, as an administrator.
Calling this action requires
* developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminForgetDeviceOutcome AdminForgetDevice(const Model::AdminForgetDeviceRequest& request) const;
/**
* A Callable wrapper for AdminForgetDevice that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminForgetDeviceOutcomeCallable AdminForgetDeviceCallable(const AdminForgetDeviceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminForgetDevice, request);
}
/**
* An Async wrapper for AdminForgetDevice that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminForgetDeviceAsync(const AdminForgetDeviceRequestT& request, const AdminForgetDeviceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminForgetDevice, request, handler, context);
}
/**
* Gets the device, as an administrator.
Calling this action requires
* developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminGetDeviceOutcome AdminGetDevice(const Model::AdminGetDeviceRequest& request) const;
/**
* A Callable wrapper for AdminGetDevice that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminGetDeviceOutcomeCallable AdminGetDeviceCallable(const AdminGetDeviceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminGetDevice, request);
}
/**
* An Async wrapper for AdminGetDevice that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminGetDeviceAsync(const AdminGetDeviceRequestT& request, const AdminGetDeviceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminGetDevice, request, handler, context);
}
/**
* Gets the specified user by user name in a user pool as an administrator.
* Works on any user.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminGetUserOutcome AdminGetUser(const Model::AdminGetUserRequest& request) const;
/**
* A Callable wrapper for AdminGetUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminGetUserOutcomeCallable AdminGetUserCallable(const AdminGetUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminGetUser, request);
}
/**
* An Async wrapper for AdminGetUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminGetUserAsync(const AdminGetUserRequestT& request, const AdminGetUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminGetUser, request, handler, context);
}
/**
* Initiates the authentication flow, as an administrator.
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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminInitiateAuthOutcome AdminInitiateAuth(const Model::AdminInitiateAuthRequest& request) const;
/**
* A Callable wrapper for AdminInitiateAuth that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminInitiateAuthOutcomeCallable AdminInitiateAuthCallable(const AdminInitiateAuthRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminInitiateAuth, request);
}
/**
* An Async wrapper for AdminInitiateAuth that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminInitiateAuthAsync(const AdminInitiateAuthRequestT& request, const AdminInitiateAuthResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminInitiateAuth, request, handler, context);
}
/**
* Links an existing user account in a user pool (DestinationUser
)
* to an identity from an external IdP (SourceUser
) 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.
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.
The maximum
* number of federated identities linked to a user is five.
* 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.
This action is administrative and requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminLinkProviderForUserOutcome AdminLinkProviderForUser(const Model::AdminLinkProviderForUserRequest& request) const;
/**
* A Callable wrapper for AdminLinkProviderForUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminLinkProviderForUserOutcomeCallable AdminLinkProviderForUserCallable(const AdminLinkProviderForUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminLinkProviderForUser, request);
}
/**
* An Async wrapper for AdminLinkProviderForUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminLinkProviderForUserAsync(const AdminLinkProviderForUserRequestT& request, const AdminLinkProviderForUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminLinkProviderForUser, request, handler, context);
}
/**
* Lists devices, as an administrator.
Calling this action requires
* developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminListDevicesOutcome AdminListDevices(const Model::AdminListDevicesRequest& request) const;
/**
* A Callable wrapper for AdminListDevices that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminListDevicesOutcomeCallable AdminListDevicesCallable(const AdminListDevicesRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminListDevices, request);
}
/**
* An Async wrapper for AdminListDevices that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminListDevicesAsync(const AdminListDevicesRequestT& request, const AdminListDevicesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminListDevices, request, handler, context);
}
/**
* Lists the groups that the user belongs to.
Calling this action
* requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminListGroupsForUserOutcome AdminListGroupsForUser(const Model::AdminListGroupsForUserRequest& request) const;
/**
* A Callable wrapper for AdminListGroupsForUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminListGroupsForUserOutcomeCallable AdminListGroupsForUserCallable(const AdminListGroupsForUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminListGroupsForUser, request);
}
/**
* An Async wrapper for AdminListGroupsForUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminListGroupsForUserAsync(const AdminListGroupsForUserRequestT& request, const AdminListGroupsForUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminListGroupsForUser, request, handler, context);
}
/**
* A history of user activity and any risks detected as part of Amazon Cognito
* advanced security.
See Also:
AWS
* API Reference
*/
virtual Model::AdminListUserAuthEventsOutcome AdminListUserAuthEvents(const Model::AdminListUserAuthEventsRequest& request) const;
/**
* A Callable wrapper for AdminListUserAuthEvents that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminListUserAuthEventsOutcomeCallable AdminListUserAuthEventsCallable(const AdminListUserAuthEventsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminListUserAuthEvents, request);
}
/**
* An Async wrapper for AdminListUserAuthEvents that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminListUserAuthEventsAsync(const AdminListUserAuthEventsRequestT& request, const AdminListUserAuthEventsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminListUserAuthEvents, request, handler, context);
}
/**
* Removes the specified user from the specified group.
Calling this
* action requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminRemoveUserFromGroupOutcome AdminRemoveUserFromGroup(const Model::AdminRemoveUserFromGroupRequest& request) const;
/**
* A Callable wrapper for AdminRemoveUserFromGroup that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminRemoveUserFromGroupOutcomeCallable AdminRemoveUserFromGroupCallable(const AdminRemoveUserFromGroupRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminRemoveUserFromGroup, request);
}
/**
* An Async wrapper for AdminRemoveUserFromGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminRemoveUserFromGroupAsync(const AdminRemoveUserFromGroupRequestT& request, const AdminRemoveUserFromGroupResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminRemoveUserFromGroup, request, handler, context);
}
/**
* 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, 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 Amazon
* Pinpoint. 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.
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
* sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminResetUserPasswordOutcome AdminResetUserPassword(const Model::AdminResetUserPasswordRequest& request) const;
/**
* A Callable wrapper for AdminResetUserPassword that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminResetUserPasswordOutcomeCallable AdminResetUserPasswordCallable(const AdminResetUserPasswordRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminResetUserPassword, request);
}
/**
* An Async wrapper for AdminResetUserPassword that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminResetUserPasswordAsync(const AdminResetUserPasswordRequestT& request, const AdminResetUserPasswordResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminResetUserPassword, request, handler, context);
}
/**
* Responds to an authentication challenge, as an administrator.
* 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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminRespondToAuthChallengeOutcome AdminRespondToAuthChallenge(const Model::AdminRespondToAuthChallengeRequest& request) const;
/**
* A Callable wrapper for AdminRespondToAuthChallenge that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminRespondToAuthChallengeOutcomeCallable AdminRespondToAuthChallengeCallable(const AdminRespondToAuthChallengeRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminRespondToAuthChallenge, request);
}
/**
* An Async wrapper for AdminRespondToAuthChallenge that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminRespondToAuthChallengeAsync(const AdminRespondToAuthChallengeRequestT& request, const AdminRespondToAuthChallengeResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminRespondToAuthChallenge, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::AdminSetUserMFAPreferenceOutcome AdminSetUserMFAPreference(const Model::AdminSetUserMFAPreferenceRequest& request) const;
/**
* A Callable wrapper for AdminSetUserMFAPreference that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminSetUserMFAPreferenceOutcomeCallable AdminSetUserMFAPreferenceCallable(const AdminSetUserMFAPreferenceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminSetUserMFAPreference, request);
}
/**
* An Async wrapper for AdminSetUserMFAPreference that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminSetUserMFAPreferenceAsync(const AdminSetUserMFAPreferenceRequestT& request, const AdminSetUserMFAPreferenceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminSetUserMFAPreference, request, handler, context);
}
/**
* 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 enters 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
* doesn't sign in before it expires, the user won't be able to sign in, and an
* administrator must reset their password.
Once the user has set a new
* password, or the password is permanent, the user status is set to
* Confirmed
.
See Also:
AWS
* API Reference
*/
virtual Model::AdminSetUserPasswordOutcome AdminSetUserPassword(const Model::AdminSetUserPasswordRequest& request) const;
/**
* A Callable wrapper for AdminSetUserPassword that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminSetUserPasswordOutcomeCallable AdminSetUserPasswordCallable(const AdminSetUserPasswordRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminSetUserPassword, request);
}
/**
* An Async wrapper for AdminSetUserPassword that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminSetUserPasswordAsync(const AdminSetUserPasswordRequestT& request, const AdminSetUserPasswordResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminSetUserPassword, request, handler, context);
}
/**
* This action is no longer supported. 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 AdminSetUserMFAPreference
* instead.
See Also:
AWS
* API Reference
*/
virtual Model::AdminSetUserSettingsOutcome AdminSetUserSettings(const Model::AdminSetUserSettingsRequest& request) const;
/**
* A Callable wrapper for AdminSetUserSettings that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminSetUserSettingsOutcomeCallable AdminSetUserSettingsCallable(const AdminSetUserSettingsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminSetUserSettings, request);
}
/**
* An Async wrapper for AdminSetUserSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminSetUserSettingsAsync(const AdminSetUserSettingsRequestT& request, const AdminSetUserSettingsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminSetUserSettings, request, handler, context);
}
/**
* 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.
See
* Also:
AWS
* API Reference
*/
virtual Model::AdminUpdateAuthEventFeedbackOutcome AdminUpdateAuthEventFeedback(const Model::AdminUpdateAuthEventFeedbackRequest& request) const;
/**
* A Callable wrapper for AdminUpdateAuthEventFeedback that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminUpdateAuthEventFeedbackOutcomeCallable AdminUpdateAuthEventFeedbackCallable(const AdminUpdateAuthEventFeedbackRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminUpdateAuthEventFeedback, request);
}
/**
* An Async wrapper for AdminUpdateAuthEventFeedback that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminUpdateAuthEventFeedbackAsync(const AdminUpdateAuthEventFeedbackRequestT& request, const AdminUpdateAuthEventFeedbackResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminUpdateAuthEventFeedback, request, handler, context);
}
/**
* Updates the device status as an administrator.
Calling this action
* requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminUpdateDeviceStatusOutcome AdminUpdateDeviceStatus(const Model::AdminUpdateDeviceStatusRequest& request) const;
/**
* A Callable wrapper for AdminUpdateDeviceStatus that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminUpdateDeviceStatusOutcomeCallable AdminUpdateDeviceStatusCallable(const AdminUpdateDeviceStatusRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminUpdateDeviceStatus, request);
}
/**
* An Async wrapper for AdminUpdateDeviceStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminUpdateDeviceStatusAsync(const AdminUpdateDeviceStatusRequestT& request, const AdminUpdateDeviceStatusResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminUpdateDeviceStatus, request, handler, context);
}
/**
* 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, 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 Amazon
* Pinpoint. 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.
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
* sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminUpdateUserAttributesOutcome AdminUpdateUserAttributes(const Model::AdminUpdateUserAttributesRequest& request) const;
/**
* A Callable wrapper for AdminUpdateUserAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminUpdateUserAttributesOutcomeCallable AdminUpdateUserAttributesCallable(const AdminUpdateUserAttributesRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminUpdateUserAttributes, request);
}
/**
* An Async wrapper for AdminUpdateUserAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminUpdateUserAttributesAsync(const AdminUpdateUserAttributesRequestT& request, const AdminUpdateUserAttributesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminUpdateUserAttributes, request, handler, context);
}
/**
* Signs out a user from all devices. You must sign
* AdminUserGlobalSignOut
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.
Calling this action
* requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::AdminUserGlobalSignOutOutcome AdminUserGlobalSignOut(const Model::AdminUserGlobalSignOutRequest& request) const;
/**
* A Callable wrapper for AdminUserGlobalSignOut that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AdminUserGlobalSignOutOutcomeCallable AdminUserGlobalSignOutCallable(const AdminUserGlobalSignOutRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AdminUserGlobalSignOut, request);
}
/**
* An Async wrapper for AdminUserGlobalSignOut that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AdminUserGlobalSignOutAsync(const AdminUserGlobalSignOutRequestT& request, const AdminUserGlobalSignOutResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AdminUserGlobalSignOut, request, handler, context);
}
/**
* 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
* AssociateSoftwareToken
request with either the user's access token,
* or a session string from a challenge response that you received from Amazon
* Cognito.
Amazon Cognito disassociates an existing software token
* when you verify the new token in a
* VerifySoftwareToken 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 MFA_SETUP
or SOFTWARE_TOKEN_SETUP
* challenge each time your user signs. Complete setup with
* AssociateSoftwareToken
and VerifySoftwareToken
.
* After you set up software token MFA for your user, Amazon Cognito generates a
* SOFTWARE_TOKEN_MFA
challenge when they authenticate. Respond to
* this challenge with your user's TOTP.
See Also:
AWS
* API Reference
*/
virtual Model::AssociateSoftwareTokenOutcome AssociateSoftwareToken(const Model::AssociateSoftwareTokenRequest& request) const;
/**
* A Callable wrapper for AssociateSoftwareToken that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AssociateSoftwareTokenOutcomeCallable AssociateSoftwareTokenCallable(const AssociateSoftwareTokenRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::AssociateSoftwareToken, request);
}
/**
* An Async wrapper for AssociateSoftwareToken that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AssociateSoftwareTokenAsync(const AssociateSoftwareTokenRequestT& request, const AssociateSoftwareTokenResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::AssociateSoftwareToken, request, handler, context);
}
/**
* Changes the password for a specified user in a user pool.
See
* Also:
AWS
* API Reference
*/
virtual Model::ChangePasswordOutcome ChangePassword(const Model::ChangePasswordRequest& request) const;
/**
* A Callable wrapper for ChangePassword that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ChangePasswordOutcomeCallable ChangePasswordCallable(const ChangePasswordRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ChangePassword, request);
}
/**
* An Async wrapper for ChangePassword that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ChangePasswordAsync(const ChangePasswordRequestT& request, const ChangePasswordResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ChangePassword, request, handler, context);
}
/**
* Confirms tracking of the device. This API call is the call that begins device
* tracking.
See Also:
AWS
* API Reference
*/
virtual Model::ConfirmDeviceOutcome ConfirmDevice(const Model::ConfirmDeviceRequest& request) const;
/**
* A Callable wrapper for ConfirmDevice that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ConfirmDeviceOutcomeCallable ConfirmDeviceCallable(const ConfirmDeviceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ConfirmDevice, request);
}
/**
* An Async wrapper for ConfirmDevice that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ConfirmDeviceAsync(const ConfirmDeviceRequestT& request, const ConfirmDeviceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ConfirmDevice, request, handler, context);
}
/**
* Allows a user to enter a confirmation code to reset a forgotten
* password.
See Also:
AWS
* API Reference
*/
virtual Model::ConfirmForgotPasswordOutcome ConfirmForgotPassword(const Model::ConfirmForgotPasswordRequest& request) const;
/**
* A Callable wrapper for ConfirmForgotPassword that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ConfirmForgotPasswordOutcomeCallable ConfirmForgotPasswordCallable(const ConfirmForgotPasswordRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ConfirmForgotPassword, request);
}
/**
* An Async wrapper for ConfirmForgotPassword that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ConfirmForgotPasswordAsync(const ConfirmForgotPasswordRequestT& request, const ConfirmForgotPasswordResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ConfirmForgotPassword, request, handler, context);
}
/**
* Confirms registration of a new user.
See Also:
AWS
* API Reference
*/
virtual Model::ConfirmSignUpOutcome ConfirmSignUp(const Model::ConfirmSignUpRequest& request) const;
/**
* A Callable wrapper for ConfirmSignUp that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ConfirmSignUpOutcomeCallable ConfirmSignUpCallable(const ConfirmSignUpRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ConfirmSignUp, request);
}
/**
* An Async wrapper for ConfirmSignUp that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ConfirmSignUpAsync(const ConfirmSignUpRequestT& request, const ConfirmSignUpResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ConfirmSignUp, request, handler, context);
}
/**
* Creates a new group in the specified user pool.
Calling this action
* requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::CreateGroupOutcome CreateGroup(const Model::CreateGroupRequest& request) const;
/**
* A Callable wrapper for CreateGroup that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateGroupOutcomeCallable CreateGroupCallable(const CreateGroupRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateGroup, request);
}
/**
* An Async wrapper for CreateGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateGroupAsync(const CreateGroupRequestT& request, const CreateGroupResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateGroup, request, handler, context);
}
/**
* Creates an IdP for a user pool.
See Also:
AWS
* API Reference
*/
virtual Model::CreateIdentityProviderOutcome CreateIdentityProvider(const Model::CreateIdentityProviderRequest& request) const;
/**
* A Callable wrapper for CreateIdentityProvider that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateIdentityProviderOutcomeCallable CreateIdentityProviderCallable(const CreateIdentityProviderRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateIdentityProvider, request);
}
/**
* An Async wrapper for CreateIdentityProvider that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateIdentityProviderAsync(const CreateIdentityProviderRequestT& request, const CreateIdentityProviderResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateIdentityProvider, request, handler, context);
}
/**
* Creates a new OAuth2.0 resource server and defines custom scopes within
* it.
See Also:
AWS
* API Reference
*/
virtual Model::CreateResourceServerOutcome CreateResourceServer(const Model::CreateResourceServerRequest& request) const;
/**
* A Callable wrapper for CreateResourceServer that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateResourceServerOutcomeCallable CreateResourceServerCallable(const CreateResourceServerRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateResourceServer, request);
}
/**
* An Async wrapper for CreateResourceServer that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateResourceServerAsync(const CreateResourceServerRequestT& request, const CreateResourceServerResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateResourceServer, request, handler, context);
}
/**
* Creates the user import job.
See Also:
AWS
* API Reference
*/
virtual Model::CreateUserImportJobOutcome CreateUserImportJob(const Model::CreateUserImportJobRequest& request) const;
/**
* A Callable wrapper for CreateUserImportJob that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateUserImportJobOutcomeCallable CreateUserImportJobCallable(const CreateUserImportJobRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateUserImportJob, request);
}
/**
* An Async wrapper for CreateUserImportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateUserImportJobAsync(const CreateUserImportJobRequestT& request, const CreateUserImportJobResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateUserImportJob, request, handler, context);
}
/**
* 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, 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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::CreateUserPoolOutcome CreateUserPool(const Model::CreateUserPoolRequest& request) const;
/**
* A Callable wrapper for CreateUserPool that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateUserPoolOutcomeCallable CreateUserPoolCallable(const CreateUserPoolRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateUserPool, request);
}
/**
* An Async wrapper for CreateUserPool that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateUserPoolAsync(const CreateUserPoolRequestT& request, const CreateUserPoolResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateUserPool, request, handler, context);
}
/**
* Creates the user pool client.
When you create a new user pool client,
* token revocation is automatically activated. For more information about revoking
* tokens, see RevokeToken.
See
* Also:
AWS
* API Reference
*/
virtual Model::CreateUserPoolClientOutcome CreateUserPoolClient(const Model::CreateUserPoolClientRequest& request) const;
/**
* A Callable wrapper for CreateUserPoolClient that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateUserPoolClientOutcomeCallable CreateUserPoolClientCallable(const CreateUserPoolClientRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateUserPoolClient, request);
}
/**
* An Async wrapper for CreateUserPoolClient that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateUserPoolClientAsync(const CreateUserPoolClientRequestT& request, const CreateUserPoolClientResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateUserPoolClient, request, handler, context);
}
/**
* Creates a new domain for a user pool.
See Also:
AWS
* API Reference
*/
virtual Model::CreateUserPoolDomainOutcome CreateUserPoolDomain(const Model::CreateUserPoolDomainRequest& request) const;
/**
* A Callable wrapper for CreateUserPoolDomain that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateUserPoolDomainOutcomeCallable CreateUserPoolDomainCallable(const CreateUserPoolDomainRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::CreateUserPoolDomain, request);
}
/**
* An Async wrapper for CreateUserPoolDomain that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateUserPoolDomainAsync(const CreateUserPoolDomainRequestT& request, const CreateUserPoolDomainResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::CreateUserPoolDomain, request, handler, context);
}
/**
* Deletes a group.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteGroupOutcome DeleteGroup(const Model::DeleteGroupRequest& request) const;
/**
* A Callable wrapper for DeleteGroup that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteGroupOutcomeCallable DeleteGroupCallable(const DeleteGroupRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteGroup, request);
}
/**
* An Async wrapper for DeleteGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteGroupAsync(const DeleteGroupRequestT& request, const DeleteGroupResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteGroup, request, handler, context);
}
/**
* Deletes an IdP for a user pool.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteIdentityProviderOutcome DeleteIdentityProvider(const Model::DeleteIdentityProviderRequest& request) const;
/**
* A Callable wrapper for DeleteIdentityProvider that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteIdentityProviderOutcomeCallable DeleteIdentityProviderCallable(const DeleteIdentityProviderRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteIdentityProvider, request);
}
/**
* An Async wrapper for DeleteIdentityProvider that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteIdentityProviderAsync(const DeleteIdentityProviderRequestT& request, const DeleteIdentityProviderResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteIdentityProvider, request, handler, context);
}
/**
* Deletes a resource server.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteResourceServerOutcome DeleteResourceServer(const Model::DeleteResourceServerRequest& request) const;
/**
* A Callable wrapper for DeleteResourceServer that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteResourceServerOutcomeCallable DeleteResourceServerCallable(const DeleteResourceServerRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteResourceServer, request);
}
/**
* An Async wrapper for DeleteResourceServer that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteResourceServerAsync(const DeleteResourceServerRequestT& request, const DeleteResourceServerResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteResourceServer, request, handler, context);
}
/**
* Allows a user to delete himself or herself.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteUserOutcome DeleteUser(const Model::DeleteUserRequest& request) const;
/**
* A Callable wrapper for DeleteUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteUserOutcomeCallable DeleteUserCallable(const DeleteUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteUser, request);
}
/**
* An Async wrapper for DeleteUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteUserAsync(const DeleteUserRequestT& request, const DeleteUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteUser, request, handler, context);
}
/**
* Deletes the attributes for a user.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteUserAttributesOutcome DeleteUserAttributes(const Model::DeleteUserAttributesRequest& request) const;
/**
* A Callable wrapper for DeleteUserAttributes that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteUserAttributesOutcomeCallable DeleteUserAttributesCallable(const DeleteUserAttributesRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteUserAttributes, request);
}
/**
* An Async wrapper for DeleteUserAttributes that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteUserAttributesAsync(const DeleteUserAttributesRequestT& request, const DeleteUserAttributesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteUserAttributes, request, handler, context);
}
/**
* Deletes the specified Amazon Cognito user pool.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteUserPoolOutcome DeleteUserPool(const Model::DeleteUserPoolRequest& request) const;
/**
* A Callable wrapper for DeleteUserPool that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteUserPoolOutcomeCallable DeleteUserPoolCallable(const DeleteUserPoolRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteUserPool, request);
}
/**
* An Async wrapper for DeleteUserPool that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteUserPoolAsync(const DeleteUserPoolRequestT& request, const DeleteUserPoolResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteUserPool, request, handler, context);
}
/**
* Allows the developer to delete the user pool client.
See Also:
* AWS
* API Reference
*/
virtual Model::DeleteUserPoolClientOutcome DeleteUserPoolClient(const Model::DeleteUserPoolClientRequest& request) const;
/**
* A Callable wrapper for DeleteUserPoolClient that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteUserPoolClientOutcomeCallable DeleteUserPoolClientCallable(const DeleteUserPoolClientRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteUserPoolClient, request);
}
/**
* An Async wrapper for DeleteUserPoolClient that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteUserPoolClientAsync(const DeleteUserPoolClientRequestT& request, const DeleteUserPoolClientResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteUserPoolClient, request, handler, context);
}
/**
* Deletes a domain for a user pool.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteUserPoolDomainOutcome DeleteUserPoolDomain(const Model::DeleteUserPoolDomainRequest& request) const;
/**
* A Callable wrapper for DeleteUserPoolDomain that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteUserPoolDomainOutcomeCallable DeleteUserPoolDomainCallable(const DeleteUserPoolDomainRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DeleteUserPoolDomain, request);
}
/**
* An Async wrapper for DeleteUserPoolDomain that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteUserPoolDomainAsync(const DeleteUserPoolDomainRequestT& request, const DeleteUserPoolDomainResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DeleteUserPoolDomain, request, handler, context);
}
/**
* Gets information about a specific IdP.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeIdentityProviderOutcome DescribeIdentityProvider(const Model::DescribeIdentityProviderRequest& request) const;
/**
* A Callable wrapper for DescribeIdentityProvider that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeIdentityProviderOutcomeCallable DescribeIdentityProviderCallable(const DescribeIdentityProviderRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeIdentityProvider, request);
}
/**
* An Async wrapper for DescribeIdentityProvider that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeIdentityProviderAsync(const DescribeIdentityProviderRequestT& request, const DescribeIdentityProviderResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeIdentityProvider, request, handler, context);
}
/**
* Describes a resource server.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeResourceServerOutcome DescribeResourceServer(const Model::DescribeResourceServerRequest& request) const;
/**
* A Callable wrapper for DescribeResourceServer that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeResourceServerOutcomeCallable DescribeResourceServerCallable(const DescribeResourceServerRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeResourceServer, request);
}
/**
* An Async wrapper for DescribeResourceServer that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeResourceServerAsync(const DescribeResourceServerRequestT& request, const DescribeResourceServerResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeResourceServer, request, handler, context);
}
/**
* Describes the risk configuration.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeRiskConfigurationOutcome DescribeRiskConfiguration(const Model::DescribeRiskConfigurationRequest& request) const;
/**
* A Callable wrapper for DescribeRiskConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeRiskConfigurationOutcomeCallable DescribeRiskConfigurationCallable(const DescribeRiskConfigurationRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeRiskConfiguration, request);
}
/**
* An Async wrapper for DescribeRiskConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeRiskConfigurationAsync(const DescribeRiskConfigurationRequestT& request, const DescribeRiskConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeRiskConfiguration, request, handler, context);
}
/**
* Describes the user import job.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeUserImportJobOutcome DescribeUserImportJob(const Model::DescribeUserImportJobRequest& request) const;
/**
* A Callable wrapper for DescribeUserImportJob that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeUserImportJobOutcomeCallable DescribeUserImportJobCallable(const DescribeUserImportJobRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeUserImportJob, request);
}
/**
* An Async wrapper for DescribeUserImportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeUserImportJobAsync(const DescribeUserImportJobRequestT& request, const DescribeUserImportJobResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeUserImportJob, request, handler, context);
}
/**
* Returns the configuration information and metadata of the specified user
* pool.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeUserPoolOutcome DescribeUserPool(const Model::DescribeUserPoolRequest& request) const;
/**
* A Callable wrapper for DescribeUserPool that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeUserPoolOutcomeCallable DescribeUserPoolCallable(const DescribeUserPoolRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeUserPool, request);
}
/**
* An Async wrapper for DescribeUserPool that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeUserPoolAsync(const DescribeUserPoolRequestT& request, const DescribeUserPoolResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeUserPool, request, handler, context);
}
/**
* Client method for returning the configuration information and metadata of the
* specified user pool app client.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeUserPoolClientOutcome DescribeUserPoolClient(const Model::DescribeUserPoolClientRequest& request) const;
/**
* A Callable wrapper for DescribeUserPoolClient that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeUserPoolClientOutcomeCallable DescribeUserPoolClientCallable(const DescribeUserPoolClientRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeUserPoolClient, request);
}
/**
* An Async wrapper for DescribeUserPoolClient that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeUserPoolClientAsync(const DescribeUserPoolClientRequestT& request, const DescribeUserPoolClientResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeUserPoolClient, request, handler, context);
}
/**
* Gets information about a domain.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeUserPoolDomainOutcome DescribeUserPoolDomain(const Model::DescribeUserPoolDomainRequest& request) const;
/**
* A Callable wrapper for DescribeUserPoolDomain that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeUserPoolDomainOutcomeCallable DescribeUserPoolDomainCallable(const DescribeUserPoolDomainRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::DescribeUserPoolDomain, request);
}
/**
* An Async wrapper for DescribeUserPoolDomain that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeUserPoolDomainAsync(const DescribeUserPoolDomainRequestT& request, const DescribeUserPoolDomainResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::DescribeUserPoolDomain, request, handler, context);
}
/**
* Forgets the specified device.
See Also:
AWS
* API Reference
*/
virtual Model::ForgetDeviceOutcome ForgetDevice(const Model::ForgetDeviceRequest& request) const;
/**
* A Callable wrapper for ForgetDevice that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ForgetDeviceOutcomeCallable ForgetDeviceCallable(const ForgetDeviceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ForgetDevice, request);
}
/**
* An Async wrapper for ForgetDevice that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ForgetDeviceAsync(const ForgetDeviceRequestT& request, const ForgetDeviceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ForgetDevice, request, handler, context);
}
/**
* 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, 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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::ForgotPasswordOutcome ForgotPassword(const Model::ForgotPasswordRequest& request) const;
/**
* A Callable wrapper for ForgotPassword that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ForgotPasswordOutcomeCallable ForgotPasswordCallable(const ForgotPasswordRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ForgotPassword, request);
}
/**
* An Async wrapper for ForgotPassword that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ForgotPasswordAsync(const ForgotPasswordRequestT& request, const ForgotPasswordResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ForgotPassword, request, handler, context);
}
/**
* Gets the header information for the comma-separated value (CSV) file to be
* used as input for the user import job.
See Also:
AWS
* API Reference
*/
virtual Model::GetCSVHeaderOutcome GetCSVHeader(const Model::GetCSVHeaderRequest& request) const;
/**
* A Callable wrapper for GetCSVHeader that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetCSVHeaderOutcomeCallable GetCSVHeaderCallable(const GetCSVHeaderRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetCSVHeader, request);
}
/**
* An Async wrapper for GetCSVHeader that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetCSVHeaderAsync(const GetCSVHeaderRequestT& request, const GetCSVHeaderResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetCSVHeader, request, handler, context);
}
/**
* Gets the device.
See Also:
AWS
* API Reference
*/
virtual Model::GetDeviceOutcome GetDevice(const Model::GetDeviceRequest& request) const;
/**
* A Callable wrapper for GetDevice that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetDeviceOutcomeCallable GetDeviceCallable(const GetDeviceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetDevice, request);
}
/**
* An Async wrapper for GetDevice that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetDeviceAsync(const GetDeviceRequestT& request, const GetDeviceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetDevice, request, handler, context);
}
/**
* Gets a group.
Calling this action requires developer
* credentials.
See Also:
AWS
* API Reference
*/
virtual Model::GetGroupOutcome GetGroup(const Model::GetGroupRequest& request) const;
/**
* A Callable wrapper for GetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetGroupOutcomeCallable GetGroupCallable(const GetGroupRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetGroup, request);
}
/**
* An Async wrapper for GetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetGroupAsync(const GetGroupRequestT& request, const GetGroupResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetGroup, request, handler, context);
}
/**
* Gets the specified IdP.
See Also:
AWS
* API Reference
*/
virtual Model::GetIdentityProviderByIdentifierOutcome GetIdentityProviderByIdentifier(const Model::GetIdentityProviderByIdentifierRequest& request) const;
/**
* A Callable wrapper for GetIdentityProviderByIdentifier that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetIdentityProviderByIdentifierOutcomeCallable GetIdentityProviderByIdentifierCallable(const GetIdentityProviderByIdentifierRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetIdentityProviderByIdentifier, request);
}
/**
* An Async wrapper for GetIdentityProviderByIdentifier that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetIdentityProviderByIdentifierAsync(const GetIdentityProviderByIdentifierRequestT& request, const GetIdentityProviderByIdentifierResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetIdentityProviderByIdentifier, request, handler, context);
}
/**
* 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.
Amazon
* Cognito issues and assigns a new signing certificate annually. This process
* returns a new value in the response to GetSigningCertificate
, but
* doesn't invalidate the original certificate.
See Also:
AWS
* API Reference
*/
virtual Model::GetSigningCertificateOutcome GetSigningCertificate(const Model::GetSigningCertificateRequest& request) const;
/**
* A Callable wrapper for GetSigningCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetSigningCertificateOutcomeCallable GetSigningCertificateCallable(const GetSigningCertificateRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetSigningCertificate, request);
}
/**
* An Async wrapper for GetSigningCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetSigningCertificateAsync(const GetSigningCertificateRequestT& request, const GetSigningCertificateResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetSigningCertificate, request, handler, context);
}
/**
* 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 clientId
is ALL
), then that information is
* returned. If nothing is present, then an empty shape is returned.
See
* Also:
AWS
* API Reference
*/
virtual Model::GetUICustomizationOutcome GetUICustomization(const Model::GetUICustomizationRequest& request) const;
/**
* A Callable wrapper for GetUICustomization that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetUICustomizationOutcomeCallable GetUICustomizationCallable(const GetUICustomizationRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetUICustomization, request);
}
/**
* An Async wrapper for GetUICustomization that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetUICustomizationAsync(const GetUICustomizationRequestT& request, const GetUICustomizationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetUICustomization, request, handler, context);
}
/**
* Gets the user attributes and metadata for a user.
See Also:
* AWS
* API Reference
*/
virtual Model::GetUserOutcome GetUser(const Model::GetUserRequest& request) const;
/**
* A Callable wrapper for GetUser that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetUserOutcomeCallable GetUserCallable(const GetUserRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetUser, request);
}
/**
* An Async wrapper for GetUser that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetUserAsync(const GetUserRequestT& request, const GetUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetUser, request, handler, context);
}
/**
* 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.
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 Amazon
* Pinpoint. 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.
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
* sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::GetUserAttributeVerificationCodeOutcome GetUserAttributeVerificationCode(const Model::GetUserAttributeVerificationCodeRequest& request) const;
/**
* A Callable wrapper for GetUserAttributeVerificationCode that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetUserAttributeVerificationCodeOutcomeCallable GetUserAttributeVerificationCodeCallable(const GetUserAttributeVerificationCodeRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetUserAttributeVerificationCode, request);
}
/**
* An Async wrapper for GetUserAttributeVerificationCode that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetUserAttributeVerificationCodeAsync(const GetUserAttributeVerificationCodeRequestT& request, const GetUserAttributeVerificationCodeResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetUserAttributeVerificationCode, request, handler, context);
}
/**
* Gets the user pool multi-factor authentication (MFA)
* configuration.
See Also:
AWS
* API Reference
*/
virtual Model::GetUserPoolMfaConfigOutcome GetUserPoolMfaConfig(const Model::GetUserPoolMfaConfigRequest& request) const;
/**
* A Callable wrapper for GetUserPoolMfaConfig that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GetUserPoolMfaConfigOutcomeCallable GetUserPoolMfaConfigCallable(const GetUserPoolMfaConfigRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GetUserPoolMfaConfig, request);
}
/**
* An Async wrapper for GetUserPoolMfaConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GetUserPoolMfaConfigAsync(const GetUserPoolMfaConfigRequestT& request, const GetUserPoolMfaConfigResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GetUserPoolMfaConfig, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::GlobalSignOutOutcome GlobalSignOut(const Model::GlobalSignOutRequest& request) const;
/**
* A Callable wrapper for GlobalSignOut that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::GlobalSignOutOutcomeCallable GlobalSignOutCallable(const GlobalSignOutRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::GlobalSignOut, request);
}
/**
* An Async wrapper for GlobalSignOut that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void GlobalSignOutAsync(const GlobalSignOutRequestT& request, const GlobalSignOutResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::GlobalSignOut, request, handler, context);
}
/**
* Initiates sign-in for a user in the Amazon Cognito user directory. You can't
* sign in a user with a federated IdP with InitiateAuth
. For more
* information, see
* Adding user pool sign-in through a third party.
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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::InitiateAuthOutcome InitiateAuth(const Model::InitiateAuthRequest& request) const;
/**
* A Callable wrapper for InitiateAuth that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::InitiateAuthOutcomeCallable InitiateAuthCallable(const InitiateAuthRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::InitiateAuth, request);
}
/**
* An Async wrapper for InitiateAuth that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void InitiateAuthAsync(const InitiateAuthRequestT& request, const InitiateAuthResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::InitiateAuth, request, handler, context);
}
/**
* Lists the sign-in devices that Amazon Cognito has registered to the current
* user.
See Also:
AWS
* API Reference
*/
virtual Model::ListDevicesOutcome ListDevices(const Model::ListDevicesRequest& request) const;
/**
* A Callable wrapper for ListDevices that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListDevicesOutcomeCallable ListDevicesCallable(const ListDevicesRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListDevices, request);
}
/**
* An Async wrapper for ListDevices that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListDevicesAsync(const ListDevicesRequestT& request, const ListDevicesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListDevices, request, handler, context);
}
/**
* Lists the groups associated with a user pool.
Calling this action
* requires developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::ListGroupsOutcome ListGroups(const Model::ListGroupsRequest& request) const;
/**
* A Callable wrapper for ListGroups that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListGroupsOutcomeCallable ListGroupsCallable(const ListGroupsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListGroups, request);
}
/**
* An Async wrapper for ListGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListGroupsAsync(const ListGroupsRequestT& request, const ListGroupsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListGroups, request, handler, context);
}
/**
* Lists information about all IdPs for a user pool.
See Also:
* AWS
* API Reference
*/
virtual Model::ListIdentityProvidersOutcome ListIdentityProviders(const Model::ListIdentityProvidersRequest& request) const;
/**
* A Callable wrapper for ListIdentityProviders that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListIdentityProvidersOutcomeCallable ListIdentityProvidersCallable(const ListIdentityProvidersRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListIdentityProviders, request);
}
/**
* An Async wrapper for ListIdentityProviders that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListIdentityProvidersAsync(const ListIdentityProvidersRequestT& request, const ListIdentityProvidersResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListIdentityProviders, request, handler, context);
}
/**
* Lists the resource servers for a user pool.
See Also:
AWS
* API Reference
*/
virtual Model::ListResourceServersOutcome ListResourceServers(const Model::ListResourceServersRequest& request) const;
/**
* A Callable wrapper for ListResourceServers that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListResourceServersOutcomeCallable ListResourceServersCallable(const ListResourceServersRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListResourceServers, request);
}
/**
* An Async wrapper for ListResourceServers that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListResourceServersAsync(const ListResourceServersRequestT& request, const ListResourceServersResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListResourceServers, request, handler, context);
}
/**
* 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.
See
* Also:
AWS
* API Reference
*/
virtual Model::ListTagsForResourceOutcome ListTagsForResource(const Model::ListTagsForResourceRequest& request) const;
/**
* A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable(const ListTagsForResourceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListTagsForResource, request);
}
/**
* An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListTagsForResourceAsync(const ListTagsForResourceRequestT& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListTagsForResource, request, handler, context);
}
/**
* Lists the user import jobs.
See Also:
AWS
* API Reference
*/
virtual Model::ListUserImportJobsOutcome ListUserImportJobs(const Model::ListUserImportJobsRequest& request) const;
/**
* A Callable wrapper for ListUserImportJobs that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListUserImportJobsOutcomeCallable ListUserImportJobsCallable(const ListUserImportJobsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListUserImportJobs, request);
}
/**
* An Async wrapper for ListUserImportJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListUserImportJobsAsync(const ListUserImportJobsRequestT& request, const ListUserImportJobsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListUserImportJobs, request, handler, context);
}
/**
* Lists the clients that have been created for the specified user
* pool.
See Also:
AWS
* API Reference
*/
virtual Model::ListUserPoolClientsOutcome ListUserPoolClients(const Model::ListUserPoolClientsRequest& request) const;
/**
* A Callable wrapper for ListUserPoolClients that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListUserPoolClientsOutcomeCallable ListUserPoolClientsCallable(const ListUserPoolClientsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListUserPoolClients, request);
}
/**
* An Async wrapper for ListUserPoolClients that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListUserPoolClientsAsync(const ListUserPoolClientsRequestT& request, const ListUserPoolClientsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListUserPoolClients, request, handler, context);
}
/**
* Lists the user pools associated with an Amazon Web Services
* account.
See Also:
AWS
* API Reference
*/
virtual Model::ListUserPoolsOutcome ListUserPools(const Model::ListUserPoolsRequest& request) const;
/**
* A Callable wrapper for ListUserPools that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListUserPoolsOutcomeCallable ListUserPoolsCallable(const ListUserPoolsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListUserPools, request);
}
/**
* An Async wrapper for ListUserPools that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListUserPoolsAsync(const ListUserPoolsRequestT& request, const ListUserPoolsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListUserPools, request, handler, context);
}
/**
* Lists the users in the Amazon Cognito user pool.
See Also:
* AWS
* API Reference
*/
virtual Model::ListUsersOutcome ListUsers(const Model::ListUsersRequest& request) const;
/**
* A Callable wrapper for ListUsers that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListUsersOutcomeCallable ListUsersCallable(const ListUsersRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListUsers, request);
}
/**
* An Async wrapper for ListUsers that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListUsersAsync(const ListUsersRequestT& request, const ListUsersResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListUsers, request, handler, context);
}
/**
* Lists the users in the specified group.
Calling this action requires
* developer credentials.
See Also:
AWS
* API Reference
*/
virtual Model::ListUsersInGroupOutcome ListUsersInGroup(const Model::ListUsersInGroupRequest& request) const;
/**
* A Callable wrapper for ListUsersInGroup that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListUsersInGroupOutcomeCallable ListUsersInGroupCallable(const ListUsersInGroupRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ListUsersInGroup, request);
}
/**
* An Async wrapper for ListUsersInGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListUsersInGroupAsync(const ListUsersInGroupRequestT& request, const ListUsersInGroupResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ListUsersInGroup, request, handler, context);
}
/**
* 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, 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 Amazon
* Pinpoint. 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.
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
* sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::ResendConfirmationCodeOutcome ResendConfirmationCode(const Model::ResendConfirmationCodeRequest& request) const;
/**
* A Callable wrapper for ResendConfirmationCode that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ResendConfirmationCodeOutcomeCallable ResendConfirmationCodeCallable(const ResendConfirmationCodeRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::ResendConfirmationCode, request);
}
/**
* An Async wrapper for ResendConfirmationCode that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ResendConfirmationCodeAsync(const ResendConfirmationCodeRequestT& request, const ResendConfirmationCodeResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::ResendConfirmationCode, request, handler, context);
}
/**
* Responds to the authentication challenge.
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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::RespondToAuthChallengeOutcome RespondToAuthChallenge(const Model::RespondToAuthChallengeRequest& request) const;
/**
* A Callable wrapper for RespondToAuthChallenge that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::RespondToAuthChallengeOutcomeCallable RespondToAuthChallengeCallable(const RespondToAuthChallengeRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::RespondToAuthChallenge, request);
}
/**
* An Async wrapper for RespondToAuthChallenge that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void RespondToAuthChallengeAsync(const RespondToAuthChallengeRequestT& request, const RespondToAuthChallengeResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::RespondToAuthChallenge, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::RevokeTokenOutcome RevokeToken(const Model::RevokeTokenRequest& request) const;
/**
* A Callable wrapper for RevokeToken that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::RevokeTokenOutcomeCallable RevokeTokenCallable(const RevokeTokenRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::RevokeToken, request);
}
/**
* An Async wrapper for RevokeToken that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void RevokeTokenAsync(const RevokeTokenRequestT& request, const RevokeTokenResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::RevokeToken, request, handler, context);
}
/**
* Configures actions on detected risks. To delete the risk configuration for
* UserPoolId
or ClientId
, pass null values for all four
* configuration types.
To activate Amazon Cognito advanced security
* features, update the user pool to include the UserPoolAddOns
* keyAdvancedSecurityMode
.
See Also:
AWS
* API Reference
*/
virtual Model::SetRiskConfigurationOutcome SetRiskConfiguration(const Model::SetRiskConfigurationRequest& request) const;
/**
* A Callable wrapper for SetRiskConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::SetRiskConfigurationOutcomeCallable SetRiskConfigurationCallable(const SetRiskConfigurationRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::SetRiskConfiguration, request);
}
/**
* An Async wrapper for SetRiskConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void SetRiskConfigurationAsync(const SetRiskConfigurationRequestT& request, const SetRiskConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::SetRiskConfiguration, request, handler, context);
}
/**
* Sets the user interface (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 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 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.
See Also:
AWS
* API Reference
*/
virtual Model::SetUICustomizationOutcome SetUICustomization(const Model::SetUICustomizationRequest& request) const;
/**
* A Callable wrapper for SetUICustomization that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::SetUICustomizationOutcomeCallable SetUICustomizationCallable(const SetUICustomizationRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::SetUICustomization, request);
}
/**
* An Async wrapper for SetUICustomization that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void SetUICustomizationAsync(const SetUICustomizationRequestT& request, const SetUICustomizationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::SetUICustomization, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::SetUserMFAPreferenceOutcome SetUserMFAPreference(const Model::SetUserMFAPreferenceRequest& request) const;
/**
* A Callable wrapper for SetUserMFAPreference that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::SetUserMFAPreferenceOutcomeCallable SetUserMFAPreferenceCallable(const SetUserMFAPreferenceRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::SetUserMFAPreference, request);
}
/**
* An Async wrapper for SetUserMFAPreference that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void SetUserMFAPreferenceAsync(const SetUserMFAPreferenceRequestT& request, const SetUserMFAPreferenceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::SetUserMFAPreference, request, handler, context);
}
/**
* Sets the user pool multi-factor authentication (MFA) configuration.
* 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 Amazon Pinpoint. 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.
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 sandbox
* mode , 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
* SMS message settings for Amazon Cognito user pools in the Amazon Cognito
* Developer Guide.
See Also:
AWS
* API Reference
*/
virtual Model::SetUserPoolMfaConfigOutcome SetUserPoolMfaConfig(const Model::SetUserPoolMfaConfigRequest& request) const;
/**
* A Callable wrapper for SetUserPoolMfaConfig that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::SetUserPoolMfaConfigOutcomeCallable SetUserPoolMfaConfigCallable(const SetUserPoolMfaConfigRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::SetUserPoolMfaConfig, request);
}
/**
* An Async wrapper for SetUserPoolMfaConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void SetUserPoolMfaConfigAsync(const SetUserPoolMfaConfigRequestT& request, const SetUserPoolMfaConfigResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::SetUserPoolMfaConfig, request, handler, context);
}
/**
* This action is no longer supported. 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 SetUserMFAPreference
* instead.
See Also:
AWS
* API Reference
*/
virtual Model::SetUserSettingsOutcome SetUserSettings(const Model::SetUserSettingsRequest& request) const;
/**
* A Callable wrapper for SetUserSettings that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::SetUserSettingsOutcomeCallable SetUserSettingsCallable(const SetUserSettingsRequestT& request) const
{
return SubmitCallable(&CognitoIdentityProviderClient::SetUserSettings, request);
}
/**
* An Async wrapper for SetUserSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void SetUserSettingsAsync(const SetUserSettingsRequestT& request, const SetUserSettingsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CognitoIdentityProviderClient::SetUserSettings, request, handler, context);
}
/**
*