AbstractAWSCognitoIdentityProvider (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.AbstractAWSCognitoIdentityProvider

All Implemented Interfaces:

AWSCognitoIdentityProvider

Direct Known Subclasses:

AbstractAWSCognitoIdentityProviderAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCognitoIdentityProvider
extends Object
implements AWSCognitoIdentityProvider
```
Abstract implementation of AWSCognitoIdentityProvider. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddCustomAttributesResult`	`addCustomAttributes(AddCustomAttributesRequest request)` Adds additional user attributes to the user pool schema.
`AdminAddUserToGroupResult`	`adminAddUserToGroup(AdminAddUserToGroupRequest request)` Adds the specified user to the specified group.
`AdminConfirmSignUpResult`	`adminConfirmSignUp(AdminConfirmSignUpRequest request)` Confirms user registration as an admin without using a confirmation code.
`AdminCreateUserResult`	`adminCreateUser(AdminCreateUserRequest request)` Creates a new user in the specified user pool.
`AdminDeleteUserResult`	`adminDeleteUser(AdminDeleteUserRequest request)` Deletes a user as an administrator.
`AdminDeleteUserAttributesResult`	`adminDeleteUserAttributes(AdminDeleteUserAttributesRequest request)` Deletes the user attributes in a user pool as an administrator.
`AdminDisableProviderForUserResult`	`adminDisableProviderForUser(AdminDisableProviderForUserRequest request)` Disables the user from signing in with the specified external (SAML or social) identity provider.
`AdminDisableUserResult`	`adminDisableUser(AdminDisableUserRequest request)` Disables the specified user.
`AdminEnableUserResult`	`adminEnableUser(AdminEnableUserRequest request)` Enables the specified user as an administrator.
`AdminForgetDeviceResult`	`adminForgetDevice(AdminForgetDeviceRequest request)` Forgets the device, as an administrator.
`AdminGetDeviceResult`	`adminGetDevice(AdminGetDeviceRequest request)` Gets the device, as an administrator.
`AdminGetUserResult`	`adminGetUser(AdminGetUserRequest request)` Gets the specified user by user name in a user pool as an administrator.
`AdminInitiateAuthResult`	`adminInitiateAuth(AdminInitiateAuthRequest request)` Initiates the authentication flow, as an administrator.
`AdminLinkProviderForUserResult`	`adminLinkProviderForUser(AdminLinkProviderForUserRequest request)` 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.
`AdminListDevicesResult`	`adminListDevices(AdminListDevicesRequest request)` Lists devices, as an administrator.
`AdminListGroupsForUserResult`	`adminListGroupsForUser(AdminListGroupsForUserRequest request)` Lists the groups that the user belongs to.
`AdminListUserAuthEventsResult`	`adminListUserAuthEvents(AdminListUserAuthEventsRequest request)` Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
`AdminRemoveUserFromGroupResult`	`adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest request)` Removes the specified user from the specified group.
`AdminResetUserPasswordResult`	`adminResetUserPassword(AdminResetUserPasswordRequest request)` Resets the specified user's password in a user pool as an administrator.
`AdminRespondToAuthChallengeResult`	`adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest request)` Responds to an authentication challenge, as an administrator.
`AdminSetUserMFAPreferenceResult`	`adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest request)` Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred.
`AdminSetUserPasswordResult`	`adminSetUserPassword(AdminSetUserPasswordRequest request)` Sets the specified user's password in a user pool as an administrator.
`AdminSetUserSettingsResult`	`adminSetUserSettings(AdminSetUserSettingsRequest request)` This action is no longer supported. You can use it to configure only SMS MFA.
`AdminUpdateAuthEventFeedbackResult`	`adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest request)` Provides feedback for an authentication event as to whether it was from a valid user.
`AdminUpdateDeviceStatusResult`	`adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest request)` Updates the device status as an administrator.
`AdminUpdateUserAttributesResult`	`adminUpdateUserAttributes(AdminUpdateUserAttributesRequest request)` Updates the specified user's attributes, including developer attributes, as an administrator.
`AdminUserGlobalSignOutResult`	`adminUserGlobalSignOut(AdminUserGlobalSignOutRequest request)` Signs out users from all devices, as an administrator.
`AssociateSoftwareTokenResult`	`associateSoftwareToken(AssociateSoftwareTokenRequest request)` Returns a unique generated shared secret key code for the user account.
`ChangePasswordResult`	`changePassword(ChangePasswordRequest request)` Changes the password for a specified user in a user pool.
`ConfirmDeviceResult`	`confirmDevice(ConfirmDeviceRequest request)` Confirms tracking of the device.
`ConfirmForgotPasswordResult`	`confirmForgotPassword(ConfirmForgotPasswordRequest request)` Allows a user to enter a confirmation code to reset a forgotten password.
`ConfirmSignUpResult`	`confirmSignUp(ConfirmSignUpRequest request)` Confirms registration of a user and handles the existing alias from a previous user.
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates a new group in the specified user pool.
`CreateIdentityProviderResult`	`createIdentityProvider(CreateIdentityProviderRequest request)` Creates an identity provider for a user pool.
`CreateResourceServerResult`	`createResourceServer(CreateResourceServerRequest request)` Creates a new OAuth2.0 resource server and defines custom scopes in it.
`CreateUserImportJobResult`	`createUserImportJob(CreateUserImportJobRequest request)` Creates the user import job.
`CreateUserPoolResult`	`createUserPool(CreateUserPoolRequest request)` Creates a new Amazon Cognito user pool and sets the password policy for the pool.
`CreateUserPoolClientResult`	`createUserPoolClient(CreateUserPoolClientRequest request)` Creates the user pool client.
`CreateUserPoolDomainResult`	`createUserPoolDomain(CreateUserPoolDomainRequest request)` Creates a new domain for a user pool.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Deletes a group.
`DeleteIdentityProviderResult`	`deleteIdentityProvider(DeleteIdentityProviderRequest request)` Deletes an identity provider for a user pool.
`DeleteResourceServerResult`	`deleteResourceServer(DeleteResourceServerRequest request)` Deletes a resource server.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Allows a user to delete himself or herself.
`DeleteUserAttributesResult`	`deleteUserAttributes(DeleteUserAttributesRequest request)` Deletes the attributes for a user.
`DeleteUserPoolResult`	`deleteUserPool(DeleteUserPoolRequest request)` Deletes the specified Amazon Cognito user pool.
`DeleteUserPoolClientResult`	`deleteUserPoolClient(DeleteUserPoolClientRequest request)` Allows the developer to delete the user pool client.
`DeleteUserPoolDomainResult`	`deleteUserPoolDomain(DeleteUserPoolDomainRequest request)` Deletes a domain for a user pool.
`DescribeIdentityProviderResult`	`describeIdentityProvider(DescribeIdentityProviderRequest request)` Gets information about a specific identity provider.
`DescribeResourceServerResult`	`describeResourceServer(DescribeResourceServerRequest request)` Describes a resource server.
`DescribeRiskConfigurationResult`	`describeRiskConfiguration(DescribeRiskConfigurationRequest request)` Describes the risk configuration.
`DescribeUserImportJobResult`	`describeUserImportJob(DescribeUserImportJobRequest request)` Describes the user import job.
`DescribeUserPoolResult`	`describeUserPool(DescribeUserPoolRequest request)` Returns the configuration information and metadata of the specified user pool.
`DescribeUserPoolClientResult`	`describeUserPoolClient(DescribeUserPoolClientRequest request)` Client method for returning the configuration information and metadata of the specified user pool app client.
`DescribeUserPoolDomainResult`	`describeUserPoolDomain(DescribeUserPoolDomainRequest request)` Gets information about a domain.
`ForgetDeviceResult`	`forgetDevice(ForgetDeviceRequest request)` Forgets the specified device.
`ForgotPasswordResult`	`forgotPassword(ForgotPasswordRequest request)` 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.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCSVHeaderResult`	`getCSVHeader(GetCSVHeaderRequest request)` Gets the header information for the .csv file to be used as input for the user import job.
`GetDeviceResult`	`getDevice(GetDeviceRequest request)` Gets the device.
`GetGroupResult`	`getGroup(GetGroupRequest request)` Gets a group.
`GetIdentityProviderByIdentifierResult`	`getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest request)` Gets the specified identity provider.
`GetSigningCertificateResult`	`getSigningCertificate(GetSigningCertificateRequest request)` This method takes a user pool ID, and returns the signing certificate.
`GetUICustomizationResult`	`getUICustomization(GetUICustomizationRequest request)` Gets the UI Customization information for a particular app client's app UI, if there is something set.
`GetUserResult`	`getUser(GetUserRequest request)` Gets the user attributes and metadata for a user.
`GetUserAttributeVerificationCodeResult`	`getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest request)` Gets the user attribute verification code for the specified attribute name.
`GetUserPoolMfaConfigResult`	`getUserPoolMfaConfig(GetUserPoolMfaConfigRequest request)` Gets the user pool multi-factor authentication (MFA) configuration.
`GlobalSignOutResult`	`globalSignOut(GlobalSignOutRequest request)` Signs out users from all devices.
`InitiateAuthResult`	`initiateAuth(InitiateAuthRequest request)` Initiates the authentication flow.
`ListDevicesResult`	`listDevices(ListDevicesRequest request)` Lists the devices.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Lists the groups associated with a user pool.
`ListIdentityProvidersResult`	`listIdentityProviders(ListIdentityProvidersRequest request)` Lists information about all identity providers for a user pool.
`ListResourceServersResult`	`listResourceServers(ListResourceServersRequest request)` Lists the resource servers for a user pool.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags that are assigned to an Amazon Cognito user pool.
`ListUserImportJobsResult`	`listUserImportJobs(ListUserImportJobsRequest request)` Lists the user import jobs.
`ListUserPoolClientsResult`	`listUserPoolClients(ListUserPoolClientsRequest request)` Lists the clients that have been created for the specified user pool.
`ListUserPoolsResult`	`listUserPools(ListUserPoolsRequest request)` Lists the user pools associated with an account.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Lists the users in the Amazon Cognito user pool.
`ListUsersInGroupResult`	`listUsersInGroup(ListUsersInGroupRequest request)` Lists the users in the specified group.
`ResendConfirmationCodeResult`	`resendConfirmationCode(ResendConfirmationCodeRequest request)` Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
`RespondToAuthChallengeResult`	`respondToAuthChallenge(RespondToAuthChallengeRequest request)` Responds to the authentication challenge.
`RevokeTokenResult`	`revokeToken(RevokeTokenRequest request)` Revokes all of the access tokens generated by the specified refresh token.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://cognito-idp.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSCognitoIdentityProvider.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`SetRiskConfigurationResult`	`setRiskConfiguration(SetRiskConfigurationRequest request)` Configures actions on detected risks.
`SetUICustomizationResult`	`setUICustomization(SetUICustomizationRequest request)` Sets the UI customization information for a user pool's built-in app UI.
`SetUserMFAPreferenceResult`	`setUserMFAPreference(SetUserMFAPreferenceRequest request)` Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred.
`SetUserPoolMfaConfigResult`	`setUserPoolMfaConfig(SetUserPoolMfaConfigRequest request)` Set the user pool multi-factor authentication (MFA) configuration.
`SetUserSettingsResult`	`setUserSettings(SetUserSettingsRequest request)` This action is no longer supported. You can use it to configure only SMS MFA.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`SignUpResult`	`signUp(SignUpRequest request)` Registers the user in the specified user pool and creates a user name, password, and user attributes.
`StartUserImportJobResult`	`startUserImportJob(StartUserImportJobRequest request)` Starts the user import.
`StopUserImportJobResult`	`stopUserImportJob(StopUserImportJobRequest request)` Stops the user import job.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns a set of tags to an Amazon Cognito user pool.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tags from an Amazon Cognito user pool.
`UpdateAuthEventFeedbackResult`	`updateAuthEventFeedback(UpdateAuthEventFeedbackRequest request)` Provides the feedback for an authentication event whether it was from a valid user or not.
`UpdateDeviceStatusResult`	`updateDeviceStatus(UpdateDeviceStatusRequest request)` Updates the device status.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest request)` Updates the specified group with the specified attributes.
`UpdateIdentityProviderResult`	`updateIdentityProvider(UpdateIdentityProviderRequest request)` Updates identity provider information for a user pool.
`UpdateResourceServerResult`	`updateResourceServer(UpdateResourceServerRequest request)` Updates the name and scopes of resource server.
`UpdateUserAttributesResult`	`updateUserAttributes(UpdateUserAttributesRequest request)` Allows a user to update a specific attribute (one at a time).
`UpdateUserPoolResult`	`updateUserPool(UpdateUserPoolRequest request)` Updates the specified user pool with the specified attributes.
`UpdateUserPoolClientResult`	`updateUserPoolClient(UpdateUserPoolClientRequest request)` Updates the specified user pool app client with the specified attributes.
`UpdateUserPoolDomainResult`	`updateUserPoolDomain(UpdateUserPoolDomainRequest request)` Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
`VerifySoftwareTokenResult`	`verifySoftwareToken(VerifySoftwareTokenRequest request)` Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful.
`VerifyUserAttributeResult`	`verifyUserAttribute(VerifyUserAttributeRequest request)` Verifies the specified user attributes in the user pool.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Overrides the default endpoint for this client ("https://cognito-idp.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "cognito-idp.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cognito-idp.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    endpoint - The endpoint (ex: "cognito-idp.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cognito-idp.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    An alternative to AWSCognitoIdentityProvider.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addCustomAttributes
```
public AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Adds additional user attributes to the user pool schema.
    
    Specified by:
    
    addCustomAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to add custom attributes.
    
    Returns:
    
    Result of the AddCustomAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminAddUserToGroup
```
public AdminAddUserToGroupResult adminAddUserToGroup(AdminAddUserToGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Adds the specified user to the specified group.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminAddUserToGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminAddUserToGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminConfirmSignUp
```
public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Confirms user registration as an admin without using a confirmation code. Works on any user.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminConfirmSignUp in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to confirm user registration.
    
    Returns:
    
    Result of the AdminConfirmSignUp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminCreateUser
```
public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates a new user in the specified user pool.
    
    If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
    
    Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.
    
    In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.
    
    AdminCreateUser requires developer credentials.
    
    Specified by:
    
    adminCreateUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to create a user in the specified user pool.
    
    Returns:
    
    Result of the AdminCreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminDeleteUser
```
public AdminDeleteUserResult adminDeleteUser(AdminDeleteUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes a user as an administrator. Works on any user.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminDeleteUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to delete a user as an administrator.
    
    Returns:
    
    Result of the AdminDeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminDeleteUserAttributes
```
public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes the user attributes in a user pool as an administrator. Works on any user.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminDeleteUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to delete user attributes as an administrator.
    
    Returns:
    
    Result of the AdminDeleteUserAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminDisableProviderForUser
```
public AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser.
    
    This action is enabled only for admin access and requires developer credentials.
    
    The ProviderName must match the value specified when creating an IdP for the pool.
    
    To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.
    
    The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.
    
    For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
    
    Specified by:
    
    adminDisableProviderForUser in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminDisableProviderForUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminDisableUser
```
public AdminDisableUserResult adminDisableUser(AdminDisableUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Disables the specified user.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminDisableUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to disable the user as an administrator.
    
    Returns:
    
    Result of the AdminDisableUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminEnableUser
```
public AdminEnableUserResult adminEnableUser(AdminEnableUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Enables the specified user as an administrator. Works on any user.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminEnableUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request that enables the user as an administrator.
    
    Returns:
    
    Result of the AdminEnableUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminForgetDevice
```
public AdminForgetDeviceResult adminForgetDevice(AdminForgetDeviceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Forgets the device, as an administrator.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminForgetDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Sends the forgot device request, as an administrator.
    
    Returns:
    
    Result of the AdminForgetDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminGetDevice
```
public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the device, as an administrator.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminGetDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to get the device, as an administrator.
    
    Returns:
    
    Result of the AdminGetDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminGetUser
```
public AdminGetUserResult adminGetUser(AdminGetUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the specified user by user name in a user pool as an administrator. Works on any user.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminGetUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to get the specified user as an administrator.
    
    Returns:
    
    Result of the AdminGetUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminInitiateAuth
```
public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Initiates the authentication flow, as an administrator.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminInitiateAuth in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Initiates the authorization request, as an administrator.
    
    Returns:
    
    Result of the AdminInitiateAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminLinkProviderForUser
```
public AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.
    
    For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
    
    The maximum number of federated identities linked to a user is 5.
    
    Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
    
    This action is enabled only for admin access and requires developer credentials.
    
    Specified by:
    
    adminLinkProviderForUser in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminLinkProviderForUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminListDevices
```
public AdminListDevicesResult adminListDevices(AdminListDevicesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists devices, as an administrator.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminListDevices in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to list devices, as an administrator.
    
    Returns:
    
    Result of the AdminListDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminListGroupsForUser
```
public AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the groups that the user belongs to.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminListGroupsForUser in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminListGroupsForUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminListUserAuthEvents
```
public AdminListUserAuthEventsResult adminListUserAuthEvents(AdminListUserAuthEventsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
    
    Specified by:
    
    adminListUserAuthEvents in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminListUserAuthEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminRemoveUserFromGroup
```
public AdminRemoveUserFromGroupResult adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Removes the specified user from the specified group.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminRemoveUserFromGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminRemoveUserFromGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminResetUserPassword
```
public AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Resets the specified user's password in a user pool as an administrator. Works on any user.
    
    When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminResetUserPassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to reset a user's password as an administrator.
    
    Returns:
    
    Result of the AdminResetUserPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminRespondToAuthChallenge
```
public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Responds to an authentication challenge, as an administrator.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminRespondToAuthChallenge in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The request to respond to the authentication challenge, as an administrator.
    
    Returns:
    
    Result of the AdminRespondToAuthChallenge operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminSetUserMFAPreference
```
public AdminSetUserMFAPreferenceResult adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
    
    Specified by:
    
    adminSetUserMFAPreference in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminSetUserMFAPreference operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminSetUserPassword
```
public AdminSetUserPasswordResult adminSetUserPassword(AdminSetUserPasswordRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Sets the specified user's password in a user pool as an administrator. Works on any user.
    
    The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.
    
    Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.
    
    Specified by:
    
    adminSetUserPassword in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminSetUserPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminSetUserSettings
```
public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
    
    Specified by:
    
    adminSetUserSettings in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
    
    Returns:
    
    Result of the AdminSetUserSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminUpdateAuthEventFeedback
```
public AdminUpdateAuthEventFeedbackResult adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
    
    Specified by:
    
    adminUpdateAuthEventFeedback in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AdminUpdateAuthEventFeedback operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminUpdateDeviceStatus
```
public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the device status as an administrator.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminUpdateDeviceStatus in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The request to update the device status, as an administrator.
    
    Returns:
    
    Result of the AdminUpdateDeviceStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminUpdateUserAttributes
```
public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
    
    For custom attributes, you must prepend the custom: prefix to the attribute name.
    
    In addition to updating user attributes, this API can also be used to mark phone and email as verified.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminUpdateUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to update the user's attributes as an administrator.
    
    Returns:
    
    Result of the AdminUpdateUserAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - adminUserGlobalSignOut
```
public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    adminUserGlobalSignOut in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The request to sign out of all devices, as an administrator.
    
    Returns:
    
    Result of the AdminUserGlobalSignOut operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateSoftwareToken
```
public AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
    
    Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token, their account is essentially set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then login without MFA. However, if MFA is set to Required for the user pool, the user will be asked to setup a new software token MFA during sign in.
    
    Specified by:
    
    associateSoftwareToken in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the AssociateSoftwareToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - changePassword
```
public ChangePasswordResult changePassword(ChangePasswordRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Changes the password for a specified user in a user pool.
    
    Specified by:
    
    changePassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to change a user password.
    
    Returns:
    
    Result of the ChangePassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - confirmDevice
```
public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Confirms tracking of the device. This API call is the call that begins device tracking.
    
    Specified by:
    
    confirmDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Confirms the device request.
    
    Returns:
    
    Result of the ConfirmDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - confirmForgotPassword
```
public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Allows a user to enter a confirmation code to reset a forgotten password.
    
    Specified by:
    
    confirmForgotPassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The request representing the confirmation for a password reset.
    
    Returns:
    
    Result of the ConfirmForgotPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - confirmSignUp
```
public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Confirms registration of a user and handles the existing alias from a previous user.
    
    Specified by:
    
    confirmSignUp in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to confirm registration of a user.
    
    Returns:
    
    Result of the ConfirmSignUp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates a new group in the specified user pool.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    createGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIdentityProvider
```
public CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates an identity provider for a user pool.
    
    Specified by:
    
    createIdentityProvider in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the CreateIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createResourceServer
```
public CreateResourceServerResult createResourceServer(CreateResourceServerRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates a new OAuth2.0 resource server and defines custom scopes in it.
    
    Specified by:
    
    createResourceServer in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the CreateResourceServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserImportJob
```
public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates the user import job.
    
    Specified by:
    
    createUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to create the user import job.
    
    Returns:
    
    Result of the CreateUserImportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserPool
```
public CreateUserPoolResult createUserPool(CreateUserPoolRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates a new Amazon Cognito user pool and sets the password policy for the pool.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    createUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to create a user pool.
    
    Returns:
    
    Result of the CreateUserPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserPoolClient
```
public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates the user pool client.
    
    When you create a new user pool client, token revocation is automatically enabled. For more information about revoking tokens, see RevokeToken.
    
    Specified by:
    
    createUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to create a user pool client.
    
    Returns:
    
    Result of the CreateUserPoolClient operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserPoolDomain
```
public CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Creates a new domain for a user pool.
    
    Specified by:
    
    createUserPoolDomain in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the CreateUserPoolDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes a group.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    deleteGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteIdentityProvider
```
public DeleteIdentityProviderResult deleteIdentityProvider(DeleteIdentityProviderRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes an identity provider for a user pool.
    
    Specified by:
    
    deleteIdentityProvider in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DeleteIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourceServer
```
public DeleteResourceServerResult deleteResourceServer(DeleteResourceServerRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes a resource server.
    
    Specified by:
    
    deleteResourceServer in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DeleteResourceServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Allows a user to delete himself or herself.
    
    Specified by:
    
    deleteUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to delete a user.
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserAttributes
```
public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes the attributes for a user.
    
    Specified by:
    
    deleteUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to delete user attributes.
    
    Returns:
    
    Result of the DeleteUserAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserPool
```
public DeleteUserPoolResult deleteUserPool(DeleteUserPoolRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes the specified Amazon Cognito user pool.
    
    Specified by:
    
    deleteUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to delete a user pool.
    
    Returns:
    
    Result of the DeleteUserPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserPoolClient
```
public DeleteUserPoolClientResult deleteUserPoolClient(DeleteUserPoolClientRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Allows the developer to delete the user pool client.
    
    Specified by:
    
    deleteUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to delete a user pool client.
    
    Returns:
    
    Result of the DeleteUserPoolClient operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserPoolDomain
```
public DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Deletes a domain for a user pool.
    
    Specified by:
    
    deleteUserPoolDomain in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DeleteUserPoolDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeIdentityProvider
```
public DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets information about a specific identity provider.
    
    Specified by:
    
    describeIdentityProvider in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DescribeIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeResourceServer
```
public DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Describes a resource server.
    
    Specified by:
    
    describeResourceServer in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DescribeResourceServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRiskConfiguration
```
public DescribeRiskConfigurationResult describeRiskConfiguration(DescribeRiskConfigurationRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Describes the risk configuration.
    
    Specified by:
    
    describeRiskConfiguration in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DescribeRiskConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserImportJob
```
public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Describes the user import job.
    
    Specified by:
    
    describeUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to describe the user import job.
    
    Returns:
    
    Result of the DescribeUserImportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserPool
```
public DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Returns the configuration information and metadata of the specified user pool.
    
    Specified by:
    
    describeUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to describe the user pool.
    
    Returns:
    
    Result of the DescribeUserPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserPoolClient
```
public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Client method for returning the configuration information and metadata of the specified user pool app client.
    
    Specified by:
    
    describeUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to describe a user pool client.
    
    Returns:
    
    Result of the DescribeUserPoolClient operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserPoolDomain
```
public DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets information about a domain.
    
    Specified by:
    
    describeUserPoolDomain in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the DescribeUserPoolDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - forgetDevice
```
public ForgetDeviceResult forgetDevice(ForgetDeviceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Forgets the specified device.
    
    Specified by:
    
    forgetDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to forget the device.
    
    Returns:
    
    Result of the ForgetDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - forgotPassword
```
public ForgotPasswordResult forgotPassword(ForgotPasswordRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    forgotPassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to reset a user's password.
    
    Returns:
    
    Result of the ForgotPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCSVHeader
```
public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the header information for the .csv file to be used as input for the user import job.
    
    Specified by:
    
    getCSVHeader in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to get the header information for the .csv file for the user import job.
    
    Returns:
    
    Result of the GetCSVHeader operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDevice
```
public GetDeviceResult getDevice(GetDeviceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the device.
    
    Specified by:
    
    getDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to get the device.
    
    Returns:
    
    Result of the GetDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
public GetGroupResult getGroup(GetGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets a group.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    getGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIdentityProviderByIdentifier
```
public GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the specified identity provider.
    
    Specified by:
    
    getIdentityProviderByIdentifier in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the GetIdentityProviderByIdentifier operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSigningCertificate
```
public GetSigningCertificateResult getSigningCertificate(GetSigningCertificateRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    This method takes a user pool ID, and returns the signing certificate.
    
    Specified by:
    
    getSigningCertificate in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Request to get a signing certificate from Cognito.
    
    Returns:
    
    Result of the GetSigningCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUICustomization
```
public GetUICustomizationResult getUICustomization(GetUICustomizationRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    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.
    
    Specified by:
    
    getUICustomization in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the GetUICustomization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUser
```
public GetUserResult getUser(GetUserRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the user attributes and metadata for a user.
    
    Specified by:
    
    getUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to get information about the user.
    
    Returns:
    
    Result of the GetUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUserAttributeVerificationCode
```
public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the user attribute verification code for the specified attribute name.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    getUserAttributeVerificationCode in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to get user attribute verification.
    
    Returns:
    
    Result of the GetUserAttributeVerificationCode operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUserPoolMfaConfig
```
public GetUserPoolMfaConfigResult getUserPoolMfaConfig(GetUserPoolMfaConfigRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Gets the user pool multi-factor authentication (MFA) configuration.
    
    Specified by:
    
    getUserPoolMfaConfig in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the GetUserPoolMfaConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - globalSignOut
```
public GlobalSignOutResult globalSignOut(GlobalSignOutRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
    
    Specified by:
    
    globalSignOut in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to sign out all devices.
    
    Returns:
    
    Result of the GlobalSignOut operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - initiateAuth
```
public InitiateAuthResult initiateAuth(InitiateAuthRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Initiates the authentication flow.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    initiateAuth in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Initiates the authentication request.
    
    Returns:
    
    Result of the InitiateAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDevices
```
public ListDevicesResult listDevices(ListDevicesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the devices.
    
    Specified by:
    
    listDevices in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to list the devices.
    
    Returns:
    
    Result of the ListDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the groups associated with a user pool.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    listGroups in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIdentityProviders
```
public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists information about all identity providers for a user pool.
    
    Specified by:
    
    listIdentityProviders in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the ListIdentityProviders operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResourceServers
```
public ListResourceServersResult listResourceServers(ListResourceServersRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the resource servers for a user pool.
    
    Specified by:
    
    listResourceServers in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the ListResourceServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    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.
    
    Specified by:
    
    listTagsForResource in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUserImportJobs
```
public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the user import jobs.
    
    Specified by:
    
    listUserImportJobs in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to list the user import jobs.
    
    Returns:
    
    Result of the ListUserImportJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUserPoolClients
```
public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the clients that have been created for the specified user pool.
    
    Specified by:
    
    listUserPoolClients in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to list the user pool clients.
    
    Returns:
    
    Result of the ListUserPoolClients operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUserPools
```
public ListUserPoolsResult listUserPools(ListUserPoolsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the user pools associated with an account.
    
    Specified by:
    
    listUserPools in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to list user pools.
    
    Returns:
    
    Result of the ListUserPools operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the users in the Amazon Cognito user pool.
    
    Specified by:
    
    listUsers in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to list users.
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsersInGroup
```
public ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Lists the users in the specified group.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    listUsersInGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the ListUsersInGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resendConfirmationCode
```
public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    resendConfirmationCode in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to resend the confirmation code.
    
    Returns:
    
    Result of the ResendConfirmationCode operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - respondToAuthChallenge
```
public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Responds to the authentication challenge.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    respondToAuthChallenge in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The request to respond to an authentication challenge.
    
    Returns:
    
    Result of the RespondToAuthChallenge operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - revokeToken
```
public RevokeTokenResult revokeToken(RevokeTokenRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can not use the revoked token to access Cognito authenticated APIs.
    
    Specified by:
    
    revokeToken in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the RevokeToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setRiskConfiguration
```
public SetRiskConfigurationResult setRiskConfiguration(SetRiskConfigurationRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.
    
    To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
    
    Specified by:
    
    setRiskConfiguration in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the SetRiskConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setUICustomization
```
public SetUICustomizationResult setUICustomization(SetUICustomizationRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    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.
    
    Specified by:
    
    setUICustomization in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the SetUICustomization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setUserMFAPreference
```
public SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.
    
    Specified by:
    
    setUserMFAPreference in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the SetUserMFAPreference operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setUserPoolMfaConfig
```
public SetUserPoolMfaConfigResult setUserPoolMfaConfig(SetUserPoolMfaConfigRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Set the user pool multi-factor authentication (MFA) configuration.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    setUserPoolMfaConfig in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the SetUserPoolMfaConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setUserSettings
```
public SetUserSettingsResult setUserSettings(SetUserSettingsRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
    
    Specified by:
    
    setUserSettings in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to set user settings.
    
    Returns:
    
    Result of the SetUserSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - signUp
```
public SignUpResult signUp(SignUpRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Registers the user in the specified user pool and creates a user name, password, and user attributes.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    signUp in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to register a user.
    
    Returns:
    
    Result of the SignUp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startUserImportJob
```
public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Starts the user import.
    
    Specified by:
    
    startUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to start the user import job.
    
    Returns:
    
    Result of the StartUserImportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopUserImportJob
```
public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Stops the user import job.
    
    Specified by:
    
    stopUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to stop the user import job.
    
    Returns:
    
    Result of the StopUserImportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    
    Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other.
    
    Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
    
    You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
    
    Specified by:
    
    tagResource in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
    
    Specified by:
    
    untagResource in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAuthEventFeedback
```
public UpdateAuthEventFeedbackResult updateAuthEventFeedback(UpdateAuthEventFeedbackRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
    
    Specified by:
    
    updateAuthEventFeedback in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the UpdateAuthEventFeedback operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDeviceStatus
```
public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the device status.
    
    Specified by:
    
    updateDeviceStatus in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to update the device status.
    
    Returns:
    
    Result of the UpdateDeviceStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the specified group with the specified attributes.
    
    Calling this action requires developer credentials.
    
    Specified by:
    
    updateGroup in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateIdentityProvider
```
public UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates identity provider information for a user pool.
    
    Specified by:
    
    updateIdentityProvider in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the UpdateIdentityProvider operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateResourceServer
```
public UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the name and scopes of resource server. All other fields are read-only.
    
    If you don't provide a value for an attribute, it will be set to the default value.
    
    Specified by:
    
    updateResourceServer in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the UpdateResourceServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserAttributes
```
public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Allows a user to update a specific attribute (one at a time).
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    updateUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to update user attributes.
    
    Returns:
    
    Result of the UpdateUserAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserPool
```
public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.
    
    This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.
    
    If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode , you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.
    
    Specified by:
    
    updateUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to update the user pool.
    
    Returns:
    
    Result of the UpdateUserPool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserPoolClient
```
public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
    
    If you don't provide a value for an attribute, it will be set to the default value.
    
    You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
    
    Specified by:
    
    updateUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to update the user pool client.
    
    Returns:
    
    Result of the UpdateUserPoolClient operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUserPoolDomain
```
public UpdateUserPoolDomainResult updateUserPoolDomain(UpdateUserPoolDomainRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
    
    You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
    
    A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
    
    Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
    
    However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
    
    When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Region.
    
    After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
    
    Specified by:
    
    updateUserPoolDomain in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The UpdateUserPoolDomain request input.
    
    Returns:
    
    Result of the UpdateUserPoolDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - verifySoftwareToken
```
public VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
    
    Specified by:
    
    verifySoftwareToken in interface AWSCognitoIdentityProvider
    
    Returns:
    
    Result of the VerifySoftwareToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - verifyUserAttribute
```
public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Verifies the specified user attributes in the user pool.
    
    Specified by:
    
    verifyUserAttribute in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - Represents the request to verify user attributes.
    
    Returns:
    
    Result of the VerifyUserAttribute operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCognitoIdentityProvider
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCognitoIdentityProvider
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSCognitoIdentityProvider

Field Summary

Fields inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addCustomAttributes

adminAddUserToGroup

adminConfirmSignUp

adminCreateUser

adminDeleteUser

adminDeleteUserAttributes

adminDisableProviderForUser

adminDisableUser

adminEnableUser

adminForgetDevice

adminGetDevice

adminGetUser

adminInitiateAuth

adminLinkProviderForUser

adminListDevices

adminListGroupsForUser

adminListUserAuthEvents

adminRemoveUserFromGroup

adminResetUserPassword

adminRespondToAuthChallenge

adminSetUserMFAPreference

adminSetUserPassword

adminSetUserSettings

adminUpdateAuthEventFeedback

adminUpdateDeviceStatus

adminUpdateUserAttributes

adminUserGlobalSignOut

associateSoftwareToken

changePassword

confirmDevice

confirmForgotPassword

confirmSignUp

createGroup

createIdentityProvider

createResourceServer

createUserImportJob

createUserPool

createUserPoolClient

createUserPoolDomain

deleteGroup

deleteIdentityProvider

deleteResourceServer

deleteUser

deleteUserAttributes

deleteUserPool

deleteUserPoolClient

deleteUserPoolDomain

describeIdentityProvider

describeResourceServer

describeRiskConfiguration

describeUserImportJob

describeUserPool

describeUserPoolClient

describeUserPoolDomain

forgetDevice

forgotPassword

getCSVHeader

getDevice

getGroup

getIdentityProviderByIdentifier

getSigningCertificate

getUICustomization

getUser

getUserAttributeVerificationCode

getUserPoolMfaConfig

globalSignOut

initiateAuth

listDevices

listGroups

listIdentityProviders

listResourceServers