AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing CognitoIdentityProvider Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito User Pools.

For more information, see the Amazon Cognito Documentation.

Inheritance Hierarchy

Amazon.CognitoIdentityProvider.IAmazonCognitoIdentityProvider

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonCognitoIdentityProvider
         IAmazonService, IDisposable

The IAmazonCognitoIdentityProvider type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddCustomAttributes(AddCustomAttributesRequest)

Adds additional user attributes to the user pool schema.

Public Method AddCustomAttributesAsync(AddCustomAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the AddCustomAttributes operation.

Public Method AdminAddUserToGroup(AdminAddUserToGroupRequest)

Adds the specified user to the specified group.

Requires developer credentials.

Public Method AdminAddUserToGroupAsync(AdminAddUserToGroupRequest, CancellationToken)

Initiates the asynchronous execution of the AdminAddUserToGroup operation.

Public Method AdminConfirmSignUp(AdminConfirmSignUpRequest)

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

Requires developer credentials.

Public Method AdminConfirmSignUpAsync(AdminConfirmSignUpRequest, CancellationToken)

Initiates the asynchronous execution of the AdminConfirmSignUp operation.

Public Method AdminCreateUser(AdminCreateUserRequest)

Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Requires developer credentials.

Public Method AdminCreateUserAsync(AdminCreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminCreateUser operation.

Public Method AdminDeleteUser(AdminDeleteUserRequest)

Deletes a user as an administrator. Works on any user.

Requires developer credentials.

Public Method AdminDeleteUserAsync(AdminDeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminDeleteUser operation.

Public Method AdminDeleteUserAttributes(AdminDeleteUserAttributesRequest)

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

Requires developer credentials.

Public Method AdminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the AdminDeleteUserAttributes operation.

Public Method AdminDisableProviderForUser(AdminDisableProviderForUserRequest)

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

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

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

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the 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.

Public Method AdminDisableProviderForUserAsync(AdminDisableProviderForUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminDisableProviderForUser operation.

Public Method AdminDisableUser(AdminDisableUserRequest)

Disables the specified user as an administrator. Works on any user.

Requires developer credentials.

Public Method AdminDisableUserAsync(AdminDisableUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminDisableUser operation.

Public Method AdminEnableUser(AdminEnableUserRequest)

Enables the specified user as an administrator. Works on any user.

Requires developer credentials.

Public Method AdminEnableUserAsync(AdminEnableUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminEnableUser operation.

Public Method AdminForgetDevice(AdminForgetDeviceRequest)

Forgets the device, as an administrator.

Requires developer credentials.

Public Method AdminForgetDeviceAsync(AdminForgetDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the AdminForgetDevice operation.

Public Method AdminGetDevice(AdminGetDeviceRequest)

Gets the device, as an administrator.

Requires developer credentials.

Public Method AdminGetDeviceAsync(AdminGetDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the AdminGetDevice operation.

Public Method AdminGetUser(AdminGetUserRequest)

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

Requires developer credentials.

Public Method AdminGetUserAsync(AdminGetUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminGetUser operation.

Public Method AdminInitiateAuth(AdminInitiateAuthRequest)

Initiates the authentication flow, as an administrator.

Requires developer credentials.

Public Method AdminInitiateAuthAsync(AdminInitiateAuthRequest, CancellationToken)

Initiates the asynchronous execution of the AdminInitiateAuth operation.

Public Method AdminLinkProviderForUser(AdminLinkProviderForUserRequest)

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

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

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.

See also AdminDisableProviderForUser.

This action is enabled only for admin access and requires developer credentials.

Public Method AdminLinkProviderForUserAsync(AdminLinkProviderForUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminLinkProviderForUser operation.

Public Method AdminListDevices(AdminListDevicesRequest)

Lists devices, as an administrator.

Requires developer credentials.

Public Method AdminListDevicesAsync(AdminListDevicesRequest, CancellationToken)

Initiates the asynchronous execution of the AdminListDevices operation.

Public Method AdminListGroupsForUser(AdminListGroupsForUserRequest)

Lists the groups that the user belongs to.

Requires developer credentials.

Public Method AdminListGroupsForUserAsync(AdminListGroupsForUserRequest, CancellationToken)

Initiates the asynchronous execution of the AdminListGroupsForUser operation.

Public Method AdminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest)

Removes the specified user from the specified group.

Requires developer credentials.

Public Method AdminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest, CancellationToken)

Initiates the asynchronous execution of the AdminRemoveUserFromGroup operation.

Public Method AdminResetUserPassword(AdminResetUserPasswordRequest)

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 credentials.

Public Method AdminResetUserPasswordAsync(AdminResetUserPasswordRequest, CancellationToken)

Initiates the asynchronous execution of the AdminResetUserPassword operation.

Public Method AdminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest)

Responds to an authentication challenge, as an administrator.

Requires developer credentials.

Public Method AdminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest, CancellationToken)

Initiates the asynchronous execution of the AdminRespondToAuthChallenge operation.

Public Method AdminSetUserSettings(AdminSetUserSettingsRequest)

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

Requires developer credentials.

Public Method AdminSetUserSettingsAsync(AdminSetUserSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the AdminSetUserSettings operation.

Public Method AdminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest)

Updates the device status as an administrator.

Requires developer credentials.

Public Method AdminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest, CancellationToken)

Initiates the asynchronous execution of the AdminUpdateDeviceStatus operation.

Public Method AdminUpdateUserAttributes(AdminUpdateUserAttributesRequest)

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.

Requires developer credentials.

Public Method AdminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the AdminUpdateUserAttributes operation.

Public Method AdminUserGlobalSignOut(AdminUserGlobalSignOutRequest)

Signs out users from all devices, as an administrator.

Requires developer credentials.

Public Method AdminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest, CancellationToken)

Initiates the asynchronous execution of the AdminUserGlobalSignOut operation.

Public Method ChangePassword(ChangePasswordRequest)

Changes the password for a specified user in a user pool.

Public Method ChangePasswordAsync(ChangePasswordRequest, CancellationToken)

Initiates the asynchronous execution of the ChangePassword operation.

Public Method ConfirmDevice(ConfirmDeviceRequest)

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

Public Method ConfirmDeviceAsync(ConfirmDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the ConfirmDevice operation.

Public Method ConfirmForgotPassword(ConfirmForgotPasswordRequest)

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

Public Method ConfirmForgotPasswordAsync(ConfirmForgotPasswordRequest, CancellationToken)

Initiates the asynchronous execution of the ConfirmForgotPassword operation.

Public Method ConfirmSignUp(ConfirmSignUpRequest)

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

Public Method ConfirmSignUpAsync(ConfirmSignUpRequest, CancellationToken)

Initiates the asynchronous execution of the ConfirmSignUp operation.

Public Method CreateGroup(CreateGroupRequest)

Creates a new group in the specified user pool.

Requires developer credentials.

Public Method CreateGroupAsync(CreateGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateGroup operation.

Public Method CreateIdentityProvider(CreateIdentityProviderRequest)

Creates an identity provider for a user pool.

Public Method CreateIdentityProviderAsync(CreateIdentityProviderRequest, CancellationToken)

Initiates the asynchronous execution of the CreateIdentityProvider operation.

Public Method CreateResourceServer(CreateResourceServerRequest)

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

Public Method CreateResourceServerAsync(CreateResourceServerRequest, CancellationToken)

Initiates the asynchronous execution of the CreateResourceServer operation.

Public Method CreateUserImportJob(CreateUserImportJobRequest)

Creates the user import job.

Public Method CreateUserImportJobAsync(CreateUserImportJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUserImportJob operation.

Public Method CreateUserPool(CreateUserPoolRequest)

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

Public Method CreateUserPoolAsync(CreateUserPoolRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUserPool operation.

Public Method CreateUserPoolClient(CreateUserPoolClientRequest)

Creates the user pool client.

Public Method CreateUserPoolClientAsync(CreateUserPoolClientRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUserPoolClient operation.

Public Method CreateUserPoolDomain(CreateUserPoolDomainRequest)

Creates a new domain for a user pool.

Public Method CreateUserPoolDomainAsync(CreateUserPoolDomainRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUserPoolDomain operation.

Public Method DeleteGroup(DeleteGroupRequest)

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

Requires developer credentials.

Public Method DeleteGroupAsync(DeleteGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteGroup operation.

Public Method DeleteIdentityProvider(DeleteIdentityProviderRequest)

Deletes an identity provider for a user pool.

Public Method DeleteIdentityProviderAsync(DeleteIdentityProviderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteIdentityProvider operation.

Public Method DeleteResourceServer(DeleteResourceServerRequest)

Deletes a resource server.

Public Method DeleteResourceServerAsync(DeleteResourceServerRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteResourceServer operation.

Public Method DeleteUser(DeleteUserRequest)

Allows a user to delete himself or herself.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DeleteUserAttributes(DeleteUserAttributesRequest)

Deletes the attributes for a user.

Public Method DeleteUserAttributesAsync(DeleteUserAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserAttributes operation.

Public Method DeleteUserPool(DeleteUserPoolRequest)

Deletes the specified Amazon Cognito user pool.

Public Method DeleteUserPoolAsync(DeleteUserPoolRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserPool operation.

Public Method DeleteUserPoolClient(DeleteUserPoolClientRequest)

Allows the developer to delete the user pool client.

Public Method DeleteUserPoolClientAsync(DeleteUserPoolClientRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserPoolClient operation.

Public Method DeleteUserPoolDomain(DeleteUserPoolDomainRequest)

Deletes a domain for a user pool.

Public Method DeleteUserPoolDomainAsync(DeleteUserPoolDomainRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUserPoolDomain operation.

Public Method DescribeIdentityProvider(DescribeIdentityProviderRequest)

Gets information about a specific identity provider.

Public Method DescribeIdentityProviderAsync(DescribeIdentityProviderRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIdentityProvider operation.

Public Method DescribeResourceServer(DescribeResourceServerRequest)

Describes a resource server.

Public Method DescribeResourceServerAsync(DescribeResourceServerRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeResourceServer operation.

Public Method DescribeUserImportJob(DescribeUserImportJobRequest)

Describes the user import job.

Public Method DescribeUserImportJobAsync(DescribeUserImportJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserImportJob operation.

Public Method DescribeUserPool(DescribeUserPoolRequest)

Returns the configuration information and metadata of the specified user pool.

Public Method DescribeUserPoolAsync(DescribeUserPoolRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserPool operation.

Public Method DescribeUserPoolClient(DescribeUserPoolClientRequest)

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

Public Method DescribeUserPoolClientAsync(DescribeUserPoolClientRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserPoolClient operation.

Public Method DescribeUserPoolDomain(DescribeUserPoolDomainRequest)

Gets information about a domain.

Public Method DescribeUserPoolDomainAsync(DescribeUserPoolDomainRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUserPoolDomain operation.

Public Method ForgetDevice(ForgetDeviceRequest)

Forgets the specified device.

Public Method ForgetDeviceAsync(ForgetDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the ForgetDevice operation.

Public Method ForgotPassword(ForgotPasswordRequest)

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. 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, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

Public Method ForgotPasswordAsync(ForgotPasswordRequest, CancellationToken)

Initiates the asynchronous execution of the ForgotPassword operation.

Public Method GetCSVHeader(GetCSVHeaderRequest)

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

Public Method GetCSVHeaderAsync(GetCSVHeaderRequest, CancellationToken)

Initiates the asynchronous execution of the GetCSVHeader operation.

Public Method GetDevice(GetDeviceRequest)

Gets the device.

Public Method GetDeviceAsync(GetDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the GetDevice operation.

Public Method GetGroup(GetGroupRequest)

Gets a group.

Requires developer credentials.

Public Method GetGroupAsync(GetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the GetGroup operation.

Public Method GetIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest)

Gets the specified identity provider.

Public Method GetIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest, CancellationToken)

Initiates the asynchronous execution of the GetIdentityProviderByIdentifier operation.

Public Method GetUICustomization(GetUICustomizationRequest)

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

Public Method GetUICustomizationAsync(GetUICustomizationRequest, CancellationToken)

Initiates the asynchronous execution of the GetUICustomization operation.

Public Method GetUser(GetUserRequest)

Gets the user attributes and metadata for a user.

Public Method GetUserAsync(GetUserRequest, CancellationToken)

Initiates the asynchronous execution of the GetUser operation.

Public Method GetUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest)

Gets the user attribute verification code for the specified attribute name.

Public Method GetUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest, CancellationToken)

Initiates the asynchronous execution of the GetUserAttributeVerificationCode operation.

Public Method GlobalSignOut(GlobalSignOutRequest)

Signs out users from all devices.

Public Method GlobalSignOutAsync(GlobalSignOutRequest, CancellationToken)

Initiates the asynchronous execution of the GlobalSignOut operation.

Public Method InitiateAuth(InitiateAuthRequest)

Initiates the authentication flow.

Public Method InitiateAuthAsync(InitiateAuthRequest, CancellationToken)

Initiates the asynchronous execution of the InitiateAuth operation.

Public Method ListDevices(ListDevicesRequest)

Lists the devices.

Public Method ListDevicesAsync(ListDevicesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDevices operation.

Public Method ListGroups(ListGroupsRequest)

Lists the groups associated with a user pool.

Requires developer credentials.

Public Method ListGroupsAsync(ListGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the ListGroups operation.

Public Method ListIdentityProviders(ListIdentityProvidersRequest)

Lists information about all identity providers for a user pool.

Public Method ListIdentityProvidersAsync(ListIdentityProvidersRequest, CancellationToken)

Initiates the asynchronous execution of the ListIdentityProviders operation.

Public Method ListResourceServers(ListResourceServersRequest)

Lists the resource servers for a user pool.

Public Method ListResourceServersAsync(ListResourceServersRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourceServers operation.

Public Method ListUserImportJobs(ListUserImportJobsRequest)

Lists the user import jobs.

Public Method ListUserImportJobsAsync(ListUserImportJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListUserImportJobs operation.

Public Method ListUserPoolClients(ListUserPoolClientsRequest)

Lists the clients that have been created for the specified user pool.

Public Method ListUserPoolClientsAsync(ListUserPoolClientsRequest, CancellationToken)

Initiates the asynchronous execution of the ListUserPoolClients operation.

Public Method ListUserPools(ListUserPoolsRequest)

Lists the user pools associated with an AWS account.

Public Method ListUserPoolsAsync(ListUserPoolsRequest, CancellationToken)

Initiates the asynchronous execution of the ListUserPools operation.

Public Method ListUsers(ListUsersRequest)

Lists the users in the Amazon Cognito user pool.

Public Method ListUsersAsync(ListUsersRequest, CancellationToken)

Initiates the asynchronous execution of the ListUsers operation.

Public Method ListUsersInGroup(ListUsersInGroupRequest)

Lists the users in the specified group.

Requires developer credentials.

Public Method ListUsersInGroupAsync(ListUsersInGroupRequest, CancellationToken)

Initiates the asynchronous execution of the ListUsersInGroup operation.

Public Method ResendConfirmationCode(ResendConfirmationCodeRequest)

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

Public Method ResendConfirmationCodeAsync(ResendConfirmationCodeRequest, CancellationToken)

Initiates the asynchronous execution of the ResendConfirmationCode operation.

Public Method RespondToAuthChallenge(RespondToAuthChallengeRequest)

Responds to the authentication challenge.

Public Method RespondToAuthChallengeAsync(RespondToAuthChallengeRequest, CancellationToken)

Initiates the asynchronous execution of the RespondToAuthChallenge operation.

Public Method SetUICustomization(SetUICustomizationRequest)

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

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

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

Public Method SetUICustomizationAsync(SetUICustomizationRequest, CancellationToken)

Initiates the asynchronous execution of the SetUICustomization operation.

Public Method SetUserSettings(SetUserSettingsRequest)

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 removed.

Public Method SetUserSettingsAsync(SetUserSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the SetUserSettings operation.

Public Method SignUp(SignUpRequest)

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

Public Method SignUpAsync(SignUpRequest, CancellationToken)

Initiates the asynchronous execution of the SignUp operation.

Public Method StartUserImportJob(StartUserImportJobRequest)

Starts the user import.

Public Method StartUserImportJobAsync(StartUserImportJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartUserImportJob operation.

Public Method StopUserImportJob(StopUserImportJobRequest)

Stops the user import job.

Public Method StopUserImportJobAsync(StopUserImportJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopUserImportJob operation.

Public Method UpdateDeviceStatus(UpdateDeviceStatusRequest)

Updates the device status.

Public Method UpdateDeviceStatusAsync(UpdateDeviceStatusRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDeviceStatus operation.

Public Method UpdateGroup(UpdateGroupRequest)

Updates the specified group with the specified attributes.

Requires developer credentials.

Public Method UpdateGroupAsync(UpdateGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateGroup operation.

Public Method UpdateIdentityProvider(UpdateIdentityProviderRequest)

Updates identity provider information for a user pool.

Public Method UpdateIdentityProviderAsync(UpdateIdentityProviderRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateIdentityProvider operation.

Public Method UpdateResourceServer(UpdateResourceServerRequest)

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

Public Method UpdateResourceServerAsync(UpdateResourceServerRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateResourceServer operation.

Public Method UpdateUserAttributes(UpdateUserAttributesRequest)

Allows a user to update a specific attribute (one at a time).

Public Method UpdateUserAttributesAsync(UpdateUserAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserAttributes operation.

Public Method UpdateUserPool(UpdateUserPoolRequest)

Updates the specified user pool with the specified attributes.

Public Method UpdateUserPoolAsync(UpdateUserPoolRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserPool operation.

Public Method UpdateUserPoolClient(UpdateUserPoolClientRequest)

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

Public Method UpdateUserPoolClientAsync(UpdateUserPoolClientRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUserPoolClient operation.

Public Method VerifyUserAttribute(VerifyUserAttributeRequest)

Verifies the specified user attributes in the user pool.

Public Method VerifyUserAttributeAsync(VerifyUserAttributeRequest, CancellationToken)

Initiates the asynchronous execution of the VerifyUserAttribute operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms