CognitoIdentityProviderClient Class

Member Function Documentation

CognitoIdentityProviderClient::CognitoIdentityProviderClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CognitoIdentityProviderClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CognitoIdentityProviderClient::CognitoIdentityProviderClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CognitoIdentityProviderClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddCustomAttributesResponse *CognitoIdentityProviderClient::addCustomAttributes(const AddCustomAttributesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AddCustomAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds additional user attributes to the user pool

[slot] AdminAddUserToGroupResponse *CognitoIdentityProviderClient::adminAddUserToGroup(const AdminAddUserToGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminAddUserToGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds the specified user to the specified

group>

Requires developer

[slot] AdminConfirmSignUpResponse *CognitoIdentityProviderClient::adminConfirmSignUp(const AdminConfirmSignUpRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminConfirmSignUpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Confirms user registration as an admin without using a confirmation code. Works on any

user>

Requires developer

[slot] AdminCreateUserResponse *CognitoIdentityProviderClient::adminCreateUser(const AdminCreateUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminCreateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new user in the specified user

pool>

If <code>MessageAction</code> is not set, the default is to send a welcome message via email or phone

(SMS)> <note>

This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary

password> </note>

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the <code>MessageAction</code> parameter, and Amazon Cognito will not send any email.

</p

In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change their

password>

AdminCreateUser requires developer

[slot] AdminDeleteUserResponse *CognitoIdentityProviderClient::adminDeleteUser(const AdminDeleteUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminDeleteUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a user as an administrator. Works on any

user>

Requires developer

[slot] AdminDeleteUserAttributesResponse *CognitoIdentityProviderClient::adminDeleteUserAttributes(const AdminDeleteUserAttributesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminDeleteUserAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the user attributes in a user pool as an administrator. Works on any

user>

Requires developer

[slot] AdminDisableProviderForUserResponse *CognitoIdentityProviderClient::adminDisableProviderForUser(const AdminDisableProviderForUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminDisableProviderForUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked <code>DestinationUser</code>) signs in, they must create a new user account. See

>

This action is enabled only for admin access and requires developer

credentials>

The <code>ProviderName</code> must match the value specified when creating an IdP for the pool.

</p

To disable a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>, with the <code>ProviderAttributeValue</code> being the name that is used in the user pool for the

user>

The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social identity providers. The <code>ProviderAttributeValue</code> 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 <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code> must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked in the call. (If the linking was done with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML

[slot] AdminDisableUserResponse *CognitoIdentityProviderClient::adminDisableUser(const AdminDisableUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminDisableUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disables the specified user as an administrator. Works on any

user>

Requires developer

[slot] AdminEnableUserResponse *CognitoIdentityProviderClient::adminEnableUser(const AdminEnableUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminEnableUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Enables the specified user as an administrator. Works on any

user>

Requires developer

[slot] AdminForgetDeviceResponse *CognitoIdentityProviderClient::adminForgetDevice(const AdminForgetDeviceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminForgetDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Forgets the device, as an

administrator>

Requires developer

[slot] AdminGetDeviceResponse *CognitoIdentityProviderClient::adminGetDevice(const AdminGetDeviceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminGetDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the device, as an

administrator>

Requires developer

[slot] AdminGetUserResponse *CognitoIdentityProviderClient::adminGetUser(const AdminGetUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminGetUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the specified user by user name in a user pool as an administrator. Works on any

user>

Requires developer

[slot] AdminInitiateAuthResponse *CognitoIdentityProviderClient::adminInitiateAuth(const AdminInitiateAuthRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminInitiateAuthResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Initiates the authentication flow, as an

administrator>

Requires developer

[slot] AdminLinkProviderForUserResponse *CognitoIdentityProviderClient::adminLinkProviderForUser(const AdminLinkProviderForUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminLinkProviderForUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Links an existing user account in a user pool (<code>DestinationUser</code>) to an identity from an external identity provider (<code>SourceUser</code>) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.

</p

For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.

</p <b>

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application

owner> </b>

See also

>

This action is enabled only for admin access and requires developer

[slot] AdminListDevicesResponse *CognitoIdentityProviderClient::adminListDevices(const AdminListDevicesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminListDevicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists devices, as an

administrator>

Requires developer

[slot] AdminListGroupsForUserResponse *CognitoIdentityProviderClient::adminListGroupsForUser(const AdminListGroupsForUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminListGroupsForUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the groups that the user belongs

to>

Requires developer

[slot] AdminListUserAuthEventsResponse *CognitoIdentityProviderClient::adminListUserAuthEvents(const AdminListUserAuthEventsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminListUserAuthEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists a history of user activity and any risks detected as part of Amazon Cognito advanced

[slot] AdminRemoveUserFromGroupResponse *CognitoIdentityProviderClient::adminRemoveUserFromGroup(const AdminRemoveUserFromGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminRemoveUserFromGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified user from the specified

group>

Requires developer

[slot] AdminResetUserPasswordResponse *CognitoIdentityProviderClient::adminResetUserPassword(const AdminResetUserPasswordRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminResetUserPasswordResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

Requires developer

[slot] AdminRespondToAuthChallengeResponse *CognitoIdentityProviderClient::adminRespondToAuthChallenge(const AdminRespondToAuthChallengeRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminRespondToAuthChallengeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Responds to an authentication challenge, as an

administrator>

Requires developer

[slot] AdminSetUserMFAPreferenceResponse *CognitoIdentityProviderClient::adminSetUserMFAPreference(const AdminSetUserMFAPreferenceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminSetUserMFAPreferenceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the user's multi-factor authentication (MFA)

[slot] AdminSetUserSettingsResponse *CognitoIdentityProviderClient::adminSetUserSettings(const AdminSetUserSettingsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminSetUserSettingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets all the user settings for a specified user name. Works on any

user>

Requires developer

[slot] AdminUpdateAuthEventFeedbackResponse *CognitoIdentityProviderClient::adminUpdateAuthEventFeedback(const AdminUpdateAuthEventFeedbackRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminUpdateAuthEventFeedbackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced

[slot] AdminUpdateDeviceStatusResponse *CognitoIdentityProviderClient::adminUpdateDeviceStatus(const AdminUpdateDeviceStatusRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminUpdateDeviceStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the device status as an

administrator>

Requires developer

[slot] AdminUpdateUserAttributesResponse *CognitoIdentityProviderClient::adminUpdateUserAttributes(const AdminUpdateUserAttributesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminUpdateUserAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any

user>

For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute

name>

In addition to updating user attributes, this API can also be used to mark phone and email as

verified>

Requires developer

[slot] AdminUserGlobalSignOutResponse *CognitoIdentityProviderClient::adminUserGlobalSignOut(const AdminUserGlobalSignOutRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AdminUserGlobalSignOutResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Signs out users from all devices, as an

administrator>

Requires developer

[slot] AssociateSoftwareTokenResponse *CognitoIdentityProviderClient::associateSoftwareToken(const AssociateSoftwareTokenRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an AssociateSoftwareTokenResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not

[slot] ChangePasswordResponse *CognitoIdentityProviderClient::changePassword(const ChangePasswordRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ChangePasswordResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Changes the password for a specified user in a user

[slot] ConfirmDeviceResponse *CognitoIdentityProviderClient::confirmDevice(const ConfirmDeviceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ConfirmDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Confirms tracking of the device. This API call is the call that begins device

[slot] ConfirmForgotPasswordResponse *CognitoIdentityProviderClient::confirmForgotPassword(const ConfirmForgotPasswordRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ConfirmForgotPasswordResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows a user to enter a confirmation code to reset a forgotten

[slot] ConfirmSignUpResponse *CognitoIdentityProviderClient::confirmSignUp(const ConfirmSignUpRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ConfirmSignUpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Confirms registration of a user and handles the existing alias from a previous

[slot] CreateGroupResponse *CognitoIdentityProviderClient::createGroup(const CreateGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new group in the specified user

pool>

Requires developer

[slot] CreateIdentityProviderResponse *CognitoIdentityProviderClient::createIdentityProvider(const CreateIdentityProviderRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateIdentityProviderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an identity provider for a user

[slot] CreateResourceServerResponse *CognitoIdentityProviderClient::createResourceServer(const CreateResourceServerRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateResourceServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new OAuth2.0 resource server and defines custom scopes in

[slot] CreateUserImportJobResponse *CognitoIdentityProviderClient::createUserImportJob(const CreateUserImportJobRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateUserImportJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates the user import

[slot] CreateUserPoolResponse *CognitoIdentityProviderClient::createUserPool(const CreateUserPoolRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateUserPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new Amazon Cognito user pool and sets the password policy for the

[slot] CreateUserPoolClientResponse *CognitoIdentityProviderClient::createUserPoolClient(const CreateUserPoolClientRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateUserPoolClientResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates the user pool

[slot] CreateUserPoolDomainResponse *CognitoIdentityProviderClient::createUserPoolDomain(const CreateUserPoolDomainRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an CreateUserPoolDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new domain for a user

[slot] DeleteGroupResponse *CognitoIdentityProviderClient::deleteGroup(const DeleteGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a group. Currently only groups with no members can be

deleted>

Requires developer

[slot] DeleteIdentityProviderResponse *CognitoIdentityProviderClient::deleteIdentityProvider(const DeleteIdentityProviderRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteIdentityProviderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an identity provider for a user

[slot] DeleteResourceServerResponse *CognitoIdentityProviderClient::deleteResourceServer(const DeleteResourceServerRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteResourceServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a resource

[slot] DeleteUserResponse *CognitoIdentityProviderClient::deleteUser(const DeleteUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows a user to delete himself or

[slot] DeleteUserAttributesResponse *CognitoIdentityProviderClient::deleteUserAttributes(const DeleteUserAttributesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteUserAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the attributes for a

[slot] DeleteUserPoolResponse *CognitoIdentityProviderClient::deleteUserPool(const DeleteUserPoolRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteUserPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified Amazon Cognito user

[slot] DeleteUserPoolClientResponse *CognitoIdentityProviderClient::deleteUserPoolClient(const DeleteUserPoolClientRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteUserPoolClientResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows the developer to delete the user pool

[slot] DeleteUserPoolDomainResponse *CognitoIdentityProviderClient::deleteUserPoolDomain(const DeleteUserPoolDomainRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DeleteUserPoolDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a domain for a user

[slot] DescribeIdentityProviderResponse *CognitoIdentityProviderClient::describeIdentityProvider(const DescribeIdentityProviderRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeIdentityProviderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a specific identity

[slot] DescribeResourceServerResponse *CognitoIdentityProviderClient::describeResourceServer(const DescribeResourceServerRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeResourceServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a resource

[slot] DescribeRiskConfigurationResponse *CognitoIdentityProviderClient::describeRiskConfiguration(const DescribeRiskConfigurationRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeRiskConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the risk

[slot] DescribeUserImportJobResponse *CognitoIdentityProviderClient::describeUserImportJob(const DescribeUserImportJobRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeUserImportJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the user import

[slot] DescribeUserPoolResponse *CognitoIdentityProviderClient::describeUserPool(const DescribeUserPoolRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeUserPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the configuration information and metadata of the specified user

[slot] DescribeUserPoolClientResponse *CognitoIdentityProviderClient::describeUserPoolClient(const DescribeUserPoolClientRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeUserPoolClientResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Client method for returning the configuration information and metadata of the specified user pool

[slot] DescribeUserPoolDomainResponse *CognitoIdentityProviderClient::describeUserPoolDomain(const DescribeUserPoolDomainRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an DescribeUserPoolDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] ForgetDeviceResponse *CognitoIdentityProviderClient::forgetDevice(const ForgetDeviceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ForgetDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Forgets the specified

[slot] ForgotPasswordResponse *CognitoIdentityProviderClient::forgotPassword(const ForgotPasswordRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ForgotPasswordResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the <code>Username</code> parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call

[slot] GetCSVHeaderResponse *CognitoIdentityProviderClient::getCSVHeader(const GetCSVHeaderRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetCSVHeaderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the header information for the .csv file to be used as input for the user import

[slot] GetDeviceResponse *CognitoIdentityProviderClient::getDevice(const GetDeviceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the

[slot] GetGroupResponse *CognitoIdentityProviderClient::getGroup(const GetGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a

group>

Requires developer

[slot] GetIdentityProviderByIdentifierResponse *CognitoIdentityProviderClient::getIdentityProviderByIdentifier(const GetIdentityProviderByIdentifierRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetIdentityProviderByIdentifierResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the specified identity

[slot] GetSigningCertificateResponse *CognitoIdentityProviderClient::getSigningCertificate(const GetSigningCertificateRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetSigningCertificateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This method takes a user pool ID, and returns the signing

[slot] GetUICustomizationResponse *CognitoIdentityProviderClient::getUICustomization(const GetUICustomizationRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetUICustomizationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app <code>clientId</code> will be <code>ALL</code>), then that is returned. If nothing is present, then an empty shape is

[slot] GetUserResponse *CognitoIdentityProviderClient::getUser(const GetUserRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the user attributes and metadata for a

[slot] GetUserAttributeVerificationCodeResponse *CognitoIdentityProviderClient::getUserAttributeVerificationCode(const GetUserAttributeVerificationCodeRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetUserAttributeVerificationCodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the user attribute verification code for the specified attribute

[slot] GetUserPoolMfaConfigResponse *CognitoIdentityProviderClient::getUserPoolMfaConfig(const GetUserPoolMfaConfigRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GetUserPoolMfaConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the user pool multi-factor authentication (MFA)

[slot] GlobalSignOutResponse *CognitoIdentityProviderClient::globalSignOut(const GlobalSignOutRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an GlobalSignOutResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Signs out users from all

[slot] InitiateAuthResponse *CognitoIdentityProviderClient::initiateAuth(const InitiateAuthRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an InitiateAuthResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Initiates the authentication

[slot] ListDevicesResponse *CognitoIdentityProviderClient::listDevices(const ListDevicesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListDevicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the

[slot] ListGroupsResponse *CognitoIdentityProviderClient::listGroups(const ListGroupsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the groups associated with a user

pool>

Requires developer

[slot] ListIdentityProvidersResponse *CognitoIdentityProviderClient::listIdentityProviders(const ListIdentityProvidersRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListIdentityProvidersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists information about all identity providers for a user

[slot] ListResourceServersResponse *CognitoIdentityProviderClient::listResourceServers(const ListResourceServersRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListResourceServersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the resource servers for a user

[slot] ListUserImportJobsResponse *CognitoIdentityProviderClient::listUserImportJobs(const ListUserImportJobsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListUserImportJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the user import

[slot] ListUserPoolClientsResponse *CognitoIdentityProviderClient::listUserPoolClients(const ListUserPoolClientsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListUserPoolClientsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the clients that have been created for the specified user

[slot] ListUserPoolsResponse *CognitoIdentityProviderClient::listUserPools(const ListUserPoolsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListUserPoolsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the user pools associated with an AWS

[slot] ListUsersResponse *CognitoIdentityProviderClient::listUsers(const ListUsersRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListUsersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the users in the Amazon Cognito user

[slot] ListUsersInGroupResponse *CognitoIdentityProviderClient::listUsersInGroup(const ListUsersInGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ListUsersInGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the users in the specified

group>

Requires developer

[slot] ResendConfirmationCodeResponse *CognitoIdentityProviderClient::resendConfirmationCode(const ResendConfirmationCodeRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an ResendConfirmationCodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Resends the confirmation (for confirmation of registration) to a specific user in the user

[slot] RespondToAuthChallengeResponse *CognitoIdentityProviderClient::respondToAuthChallenge(const RespondToAuthChallengeRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an RespondToAuthChallengeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Responds to the authentication

[slot] SetRiskConfigurationResponse *CognitoIdentityProviderClient::setRiskConfiguration(const SetRiskConfigurationRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an SetRiskConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Configures actions on detected risks. To delete the risk configuration for <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four configuration

types>

To enable Amazon Cognito advanced security features, update the user pool to include the <code>UserPoolAddOns</code>

key<code>AdvancedSecurityMode</code>>

See

[slot] SetUICustomizationResponse *CognitoIdentityProviderClient::setUICustomization(const SetUICustomizationRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an SetUICustomizationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the UI customization information for a user pool's built-in app

UI>

You can specify app UI customization settings for a single client (with a specific <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to <code>ALL</code>). If you specify <code>ALL</code>, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the <code>ALL</code> configuration.

</p <note>

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

[slot] SetUserMFAPreferenceResponse *CognitoIdentityProviderClient::setUserMFAPreference(const SetUserMFAPreferenceRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an SetUserMFAPreferenceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Set the user's multi-factor authentication (MFA) method

[slot] SetUserPoolMfaConfigResponse *CognitoIdentityProviderClient::setUserPoolMfaConfig(const SetUserPoolMfaConfigRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an SetUserPoolMfaConfigResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Set the user pool MFA

[slot] SetUserSettingsResponse *CognitoIdentityProviderClient::setUserSettings(const SetUserSettingsRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an SetUserSettingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are

[slot] SignUpResponse *CognitoIdentityProviderClient::signUp(const SignUpRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an SignUpResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers the user in the specified user pool and creates a user name, password, and user

[slot] StartUserImportJobResponse *CognitoIdentityProviderClient::startUserImportJob(const StartUserImportJobRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an StartUserImportJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the user

[slot] StopUserImportJobResponse *CognitoIdentityProviderClient::stopUserImportJob(const StopUserImportJobRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an StopUserImportJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the user import

[slot] UpdateAuthEventFeedbackResponse *CognitoIdentityProviderClient::updateAuthEventFeedback(const UpdateAuthEventFeedbackRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateAuthEventFeedbackResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced

[slot] UpdateDeviceStatusResponse *CognitoIdentityProviderClient::updateDeviceStatus(const UpdateDeviceStatusRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateDeviceStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the device

[slot] UpdateGroupResponse *CognitoIdentityProviderClient::updateGroup(const UpdateGroupRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified group with the specified

attributes>

Requires developer

[slot] UpdateIdentityProviderResponse *CognitoIdentityProviderClient::updateIdentityProvider(const UpdateIdentityProviderRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateIdentityProviderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates identity provider information for a user

[slot] UpdateResourceServerResponse *CognitoIdentityProviderClient::updateResourceServer(const UpdateResourceServerRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateResourceServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the name and scopes of resource server. All other fields are

[slot] UpdateUserAttributesResponse *CognitoIdentityProviderClient::updateUserAttributes(const UpdateUserAttributesRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateUserAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows a user to update a specific attribute (one at a

[slot] UpdateUserPoolResponse *CognitoIdentityProviderClient::updateUserPool(const UpdateUserPoolRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateUserPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified user pool with the specified

[slot] UpdateUserPoolClientResponse *CognitoIdentityProviderClient::updateUserPoolClient(const UpdateUserPoolClientRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an UpdateUserPoolClientResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows the developer to update the specified user pool client and password

[slot] VerifySoftwareTokenResponse *CognitoIdentityProviderClient::verifySoftwareToken(const VerifySoftwareTokenRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an VerifySoftwareTokenResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if

[slot] VerifyUserAttributeResponse *CognitoIdentityProviderClient::verifyUserAttribute(const VerifyUserAttributeRequest &request)

Sends request to the CognitoIdentityProviderClient service, and returns a pointer to an VerifyUserAttributeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Verifies the specified user attributes in the user