@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCognitoIdentityProviderAsyncClient extends AWSCognitoIdentityProviderClient implements AWSCognitoIdentityProviderAsync
AsyncHandler
can be used to
receive notification when an asynchronous operation completes.
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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, builder, 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, getCachedResponseMetadata, getCSVHeader, getDevice, getGroup, getIdentityProviderByIdentifier, getSigningCertificate, getUICustomization, getUser, getUserAttributeVerificationCode, getUserPoolMfaConfig, globalSignOut, initiateAuth, listDevices, listGroups, listIdentityProviders, listResourceServers, listTagsForResource, listUserImportJobs, listUserPoolClients, listUserPools, listUsers, listUsersInGroup, resendConfirmationCode, respondToAuthChallenge, setRiskConfiguration, setUICustomization, setUserMFAPreference, setUserPoolMfaConfig, setUserSettings, signUp, startUserImportJob, stopUserImportJob, tagResource, untagResource, updateAuthEventFeedback, updateDeviceStatus, updateGroup, updateIdentityProvider, updateResourceServer, updateUserAttributes, updateUserPool, updateUserPoolClient, updateUserPoolDomain, verifySoftwareToken, verifyUserAttribute
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, getCachedResponseMetadata, getCSVHeader, getDevice, getGroup, getIdentityProviderByIdentifier, getSigningCertificate, getUICustomization, getUser, getUserAttributeVerificationCode, getUserPoolMfaConfig, globalSignOut, initiateAuth, listDevices, listGroups, listIdentityProviders, listResourceServers, listTagsForResource, listUserImportJobs, listUserPoolClients, listUserPools, listUsers, listUsersInGroup, resendConfirmationCode, respondToAuthChallenge, setEndpoint, setRegion, setRiskConfiguration, setUICustomization, setUserMFAPreference, setUserPoolMfaConfig, setUserSettings, signUp, startUserImportJob, stopUserImportJob, tagResource, untagResource, updateAuthEventFeedback, updateDeviceStatus, updateGroup, updateIdentityProvider, updateResourceServer, updateUserAttributes, updateUserPool, updateUserPoolClient, updateUserPoolDomain, verifySoftwareToken, verifyUserAttribute
@Deprecated public AWSCognitoIdentityProviderAsyncClient()
AWSCognitoIdentityProviderAsyncClientBuilder.defaultClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AWSCognitoIdentityProviderAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Cognito Identity Provider
(ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.public static AWSCognitoIdentityProviderAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest request)
AWSCognitoIdentityProviderAsync
Adds additional user attributes to the user pool schema.
addCustomAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to add custom attributes.public Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest request, AsyncHandler<AddCustomAttributesRequest,AddCustomAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Adds additional user attributes to the user pool schema.
addCustomAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to add custom attributes.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminAddUserToGroupResult> adminAddUserToGroupAsync(AdminAddUserToGroupRequest request)
AWSCognitoIdentityProviderAsync
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminAddUserToGroupResult> adminAddUserToGroupAsync(AdminAddUserToGroupRequest request, AsyncHandler<AdminAddUserToGroupRequest,AdminAddUserToGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest request)
AWSCognitoIdentityProviderAsync
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
adminConfirmSignUpAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to confirm user registration.public Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest request, AsyncHandler<AdminConfirmSignUpRequest,AdminConfirmSignUpResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
adminConfirmSignUpAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to confirm user registration.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest request)
AWSCognitoIdentityProviderAsync
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 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.
adminCreateUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create a user in the specified user pool.public Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest request, AsyncHandler<AdminCreateUserRequest,AdminCreateUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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 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.
adminCreateUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create a user in the specified user pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest request)
AWSCognitoIdentityProviderAsync
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user as an administrator.public Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest request, AsyncHandler<AdminDeleteUserRequest,AdminDeleteUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request)
AWSCognitoIdentityProviderAsync
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete user attributes as an administrator.public Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request, AsyncHandler<AdminDeleteUserAttributesRequest,AdminDeleteUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete user attributes as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminDisableProviderForUserResult> adminDisableProviderForUserAsync(AdminDisableProviderForUserRequest request)
AWSCognitoIdentityProviderAsync
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.
adminDisableProviderForUserAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminDisableProviderForUserResult> adminDisableProviderForUserAsync(AdminDisableProviderForUserRequest request, AsyncHandler<AdminDisableProviderForUserRequest,AdminDisableProviderForUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
adminDisableProviderForUserAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest request)
AWSCognitoIdentityProviderAsync
Disables the specified user.
Calling this action requires developer credentials.
adminDisableUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to disable any user as an administrator.public Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest request, AsyncHandler<AdminDisableUserRequest,AdminDisableUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Disables the specified user.
Calling this action requires developer credentials.
adminDisableUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to disable any user as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest request)
AWSCognitoIdentityProviderAsync
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminEnableUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request that enables the user as an administrator.public Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest request, AsyncHandler<AdminEnableUserRequest,AdminEnableUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminEnableUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request that enables the user as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest request)
AWSCognitoIdentityProviderAsync
Forgets the device, as an administrator.
Calling this action requires developer credentials.
adminForgetDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Sends the forgot device request, as an administrator.public Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest request, AsyncHandler<AdminForgetDeviceRequest,AdminForgetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Forgets the device, as an administrator.
Calling this action requires developer credentials.
adminForgetDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Sends the forgot device request, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest request)
AWSCognitoIdentityProviderAsync
Gets the device, as an administrator.
Calling this action requires developer credentials.
adminGetDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the device, as an administrator.public Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest request, AsyncHandler<AdminGetDeviceRequest,AdminGetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the device, as an administrator.
Calling this action requires developer credentials.
adminGetDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the device, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest request)
AWSCognitoIdentityProviderAsync
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminGetUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the specified user as an administrator.public Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest request, AsyncHandler<AdminGetUserRequest,AdminGetUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminGetUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the specified user as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest request)
AWSCognitoIdentityProviderAsync
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
adminInitiateAuthAsync
in interface AWSCognitoIdentityProviderAsync
request
- Initiates the authorization request, as an administrator.public Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest request, AsyncHandler<AdminInitiateAuthRequest,AdminInitiateAuthResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
adminInitiateAuthAsync
in interface AWSCognitoIdentityProviderAsync
request
- Initiates the authorization request, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminLinkProviderForUserResult> adminLinkProviderForUserAsync(AdminLinkProviderForUserRequest request)
AWSCognitoIdentityProviderAsync
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.
adminLinkProviderForUserAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminLinkProviderForUserResult> adminLinkProviderForUserAsync(AdminLinkProviderForUserRequest request, AsyncHandler<AdminLinkProviderForUserRequest,AdminLinkProviderForUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
adminLinkProviderForUserAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest request)
AWSCognitoIdentityProviderAsync
Lists devices, as an administrator.
Calling this action requires developer credentials.
adminListDevicesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list devices, as an administrator.public Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest request, AsyncHandler<AdminListDevicesRequest,AdminListDevicesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists devices, as an administrator.
Calling this action requires developer credentials.
adminListDevicesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list devices, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminListGroupsForUserResult> adminListGroupsForUserAsync(AdminListGroupsForUserRequest request)
AWSCognitoIdentityProviderAsync
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUserAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminListGroupsForUserResult> adminListGroupsForUserAsync(AdminListGroupsForUserRequest request, AsyncHandler<AdminListGroupsForUserRequest,AdminListGroupsForUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUserAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminListUserAuthEventsResult> adminListUserAuthEventsAsync(AdminListUserAuthEventsRequest request)
AWSCognitoIdentityProviderAsync
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEventsAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminListUserAuthEventsResult> adminListUserAuthEventsAsync(AdminListUserAuthEventsRequest request, AsyncHandler<AdminListUserAuthEventsRequest,AdminListUserAuthEventsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEventsAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminRemoveUserFromGroupResult> adminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest request)
AWSCognitoIdentityProviderAsync
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminRemoveUserFromGroupResult> adminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest request, AsyncHandler<AdminRemoveUserFromGroupRequest,AdminRemoveUserFromGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest request)
AWSCognitoIdentityProviderAsync
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.
Calling this action requires developer credentials.
adminResetUserPasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to reset a user's password as an administrator.public Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest request, AsyncHandler<AdminResetUserPasswordRequest,AdminResetUserPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
Calling this action requires developer credentials.
adminResetUserPasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to reset a user's password as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest request)
AWSCognitoIdentityProviderAsync
Responds to an authentication challenge, as an administrator.
Calling this action requires developer credentials.
adminRespondToAuthChallengeAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to respond to the authentication challenge, as an administrator.public Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest request, AsyncHandler<AdminRespondToAuthChallengeRequest,AdminRespondToAuthChallengeResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Responds to an authentication challenge, as an administrator.
Calling this action requires developer credentials.
adminRespondToAuthChallengeAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to respond to the authentication challenge, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminSetUserMFAPreferenceResult> adminSetUserMFAPreferenceAsync(AdminSetUserMFAPreferenceRequest request)
AWSCognitoIdentityProviderAsync
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.
adminSetUserMFAPreferenceAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminSetUserMFAPreferenceResult> adminSetUserMFAPreferenceAsync(AdminSetUserMFAPreferenceRequest request, AsyncHandler<AdminSetUserMFAPreferenceRequest,AdminSetUserMFAPreferenceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
adminSetUserMFAPreferenceAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminSetUserPasswordResult> adminSetUserPasswordAsync(AdminSetUserPasswordRequest request)
AWSCognitoIdentityProviderAsync
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
.
adminSetUserPasswordAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminSetUserPasswordResult> adminSetUserPasswordAsync(AdminSetUserPasswordRequest request, AsyncHandler<AdminSetUserPasswordRequest,AdminSetUserPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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
.
adminSetUserPasswordAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest request)
AWSCognitoIdentityProviderAsync
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.
adminSetUserSettingsAsync
in interface AWSCognitoIdentityProviderAsync
request
- You can use this parameter to set an MFA configuration that uses the SMS delivery medium.public Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest request, AsyncHandler<AdminSetUserSettingsRequest,AdminSetUserSettingsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
adminSetUserSettingsAsync
in interface AWSCognitoIdentityProviderAsync
request
- You can use this parameter to set an MFA configuration that uses the SMS delivery medium.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminUpdateAuthEventFeedbackResult> adminUpdateAuthEventFeedbackAsync(AdminUpdateAuthEventFeedbackRequest request)
AWSCognitoIdentityProviderAsync
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.
adminUpdateAuthEventFeedbackAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AdminUpdateAuthEventFeedbackResult> adminUpdateAuthEventFeedbackAsync(AdminUpdateAuthEventFeedbackRequest request, AsyncHandler<AdminUpdateAuthEventFeedbackRequest,AdminUpdateAuthEventFeedbackResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
adminUpdateAuthEventFeedbackAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest request)
AWSCognitoIdentityProviderAsync
Updates the device status as an administrator.
Calling this action requires developer credentials.
adminUpdateDeviceStatusAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to update the device status, as an administrator.public Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest request, AsyncHandler<AdminUpdateDeviceStatusRequest,AdminUpdateDeviceStatusResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Updates the device status as an administrator.
Calling this action requires developer credentials.
adminUpdateDeviceStatusAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to update the device status, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request)
AWSCognitoIdentityProviderAsync
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.
Calling this action requires developer credentials.
adminUpdateUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the user's attributes as an administrator.public Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request, AsyncHandler<AdminUpdateUserAttributesRequest,AdminUpdateUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
Calling this action requires developer credentials.
adminUpdateUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the user's attributes as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest request)
AWSCognitoIdentityProviderAsync
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.
adminUserGlobalSignOutAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to sign out of all devices, as an administrator.public Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest request, AsyncHandler<AdminUserGlobalSignOutRequest,AdminUserGlobalSignOutResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
adminUserGlobalSignOutAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to sign out of all devices, as an administrator.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateSoftwareTokenResult> associateSoftwareTokenAsync(AssociateSoftwareTokenRequest request)
AWSCognitoIdentityProviderAsync
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.
associateSoftwareTokenAsync
in interface AWSCognitoIdentityProviderAsync
public Future<AssociateSoftwareTokenResult> associateSoftwareTokenAsync(AssociateSoftwareTokenRequest request, AsyncHandler<AssociateSoftwareTokenRequest,AssociateSoftwareTokenResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
associateSoftwareTokenAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest request)
AWSCognitoIdentityProviderAsync
Changes the password for a specified user in a user pool.
changePasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to change a user password.public Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest request, AsyncHandler<ChangePasswordRequest,ChangePasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Changes the password for a specified user in a user pool.
changePasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to change a user password.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest request)
AWSCognitoIdentityProviderAsync
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Confirms the device request.public Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest request, AsyncHandler<ConfirmDeviceRequest,ConfirmDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Confirms the device request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request)
AWSCognitoIdentityProviderAsync
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request representing the confirmation for a password reset.public Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request, AsyncHandler<ConfirmForgotPasswordRequest,ConfirmForgotPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request representing the confirmation for a password reset.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest request)
AWSCognitoIdentityProviderAsync
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to confirm registration of a user.public Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest request, AsyncHandler<ConfirmSignUpRequest,ConfirmSignUpResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to confirm registration of a user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AWSCognitoIdentityProviderAsync
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIdentityProviderResult> createIdentityProviderAsync(CreateIdentityProviderRequest request)
AWSCognitoIdentityProviderAsync
Creates an identity provider for a user pool.
createIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
public Future<CreateIdentityProviderResult> createIdentityProviderAsync(CreateIdentityProviderRequest request, AsyncHandler<CreateIdentityProviderRequest,CreateIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates an identity provider for a user pool.
createIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateResourceServerResult> createResourceServerAsync(CreateResourceServerRequest request)
AWSCognitoIdentityProviderAsync
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
public Future<CreateResourceServerResult> createResourceServerAsync(CreateResourceServerRequest request, AsyncHandler<CreateResourceServerRequest,CreateResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest request)
AWSCognitoIdentityProviderAsync
Creates the user import job.
createUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create the user import job.public Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest request, AsyncHandler<CreateUserImportJobRequest,CreateUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates the user import job.
createUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create the user import job.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest request)
AWSCognitoIdentityProviderAsync
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create a user pool.public Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest request, AsyncHandler<CreateUserPoolRequest,CreateUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create a user pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest request)
AWSCognitoIdentityProviderAsync
Creates the user pool client.
createUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create a user pool client.public Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest request, AsyncHandler<CreateUserPoolClientRequest,CreateUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates the user pool client.
createUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to create a user pool client.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserPoolDomainResult> createUserPoolDomainAsync(CreateUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsync
Creates a new domain for a user pool.
createUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
public Future<CreateUserPoolDomainResult> createUserPoolDomainAsync(CreateUserPoolDomainRequest request, AsyncHandler<CreateUserPoolDomainRequest,CreateUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Creates a new domain for a user pool.
createUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AWSCognitoIdentityProviderAsync
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteIdentityProviderResult> deleteIdentityProviderAsync(DeleteIdentityProviderRequest request)
AWSCognitoIdentityProviderAsync
Deletes an identity provider for a user pool.
deleteIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DeleteIdentityProviderResult> deleteIdentityProviderAsync(DeleteIdentityProviderRequest request, AsyncHandler<DeleteIdentityProviderRequest,DeleteIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes an identity provider for a user pool.
deleteIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteResourceServerResult> deleteResourceServerAsync(DeleteResourceServerRequest request)
AWSCognitoIdentityProviderAsync
Deletes a resource server.
deleteResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DeleteResourceServerResult> deleteResourceServerAsync(DeleteResourceServerRequest request, AsyncHandler<DeleteResourceServerRequest,DeleteResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes a resource server.
deleteResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AWSCognitoIdentityProviderAsync
Allows a user to delete himself or herself.
deleteUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Allows a user to delete himself or herself.
deleteUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest request)
AWSCognitoIdentityProviderAsync
Deletes the attributes for a user.
deleteUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete user attributes.public Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest request, AsyncHandler<DeleteUserAttributesRequest,DeleteUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes the attributes for a user.
deleteUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete user attributes.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest request)
AWSCognitoIdentityProviderAsync
Deletes the specified Amazon Cognito user pool.
deleteUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user pool.public Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest request, AsyncHandler<DeleteUserPoolRequest,DeleteUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes the specified Amazon Cognito user pool.
deleteUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest request)
AWSCognitoIdentityProviderAsync
Allows the developer to delete the user pool client.
deleteUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user pool client.public Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest request, AsyncHandler<DeleteUserPoolClientRequest,DeleteUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Allows the developer to delete the user pool client.
deleteUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to delete a user pool client.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserPoolDomainResult> deleteUserPoolDomainAsync(DeleteUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsync
Deletes a domain for a user pool.
deleteUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DeleteUserPoolDomainResult> deleteUserPoolDomainAsync(DeleteUserPoolDomainRequest request, AsyncHandler<DeleteUserPoolDomainRequest,DeleteUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Deletes a domain for a user pool.
deleteUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIdentityProviderResult> describeIdentityProviderAsync(DescribeIdentityProviderRequest request)
AWSCognitoIdentityProviderAsync
Gets information about a specific identity provider.
describeIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DescribeIdentityProviderResult> describeIdentityProviderAsync(DescribeIdentityProviderRequest request, AsyncHandler<DescribeIdentityProviderRequest,DescribeIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets information about a specific identity provider.
describeIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeResourceServerResult> describeResourceServerAsync(DescribeResourceServerRequest request)
AWSCognitoIdentityProviderAsync
Describes a resource server.
describeResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DescribeResourceServerResult> describeResourceServerAsync(DescribeResourceServerRequest request, AsyncHandler<DescribeResourceServerRequest,DescribeResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Describes a resource server.
describeResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRiskConfigurationResult> describeRiskConfigurationAsync(DescribeRiskConfigurationRequest request)
AWSCognitoIdentityProviderAsync
Describes the risk configuration.
describeRiskConfigurationAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DescribeRiskConfigurationResult> describeRiskConfigurationAsync(DescribeRiskConfigurationRequest request, AsyncHandler<DescribeRiskConfigurationRequest,DescribeRiskConfigurationResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Describes the risk configuration.
describeRiskConfigurationAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest request)
AWSCognitoIdentityProviderAsync
Describes the user import job.
describeUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to describe the user import job.public Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest request, AsyncHandler<DescribeUserImportJobRequest,DescribeUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Describes the user import job.
describeUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to describe the user import job.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest request)
AWSCognitoIdentityProviderAsync
Returns the configuration information and metadata of the specified user pool.
describeUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to describe the user pool.public Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest request, AsyncHandler<DescribeUserPoolRequest,DescribeUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Returns the configuration information and metadata of the specified user pool.
describeUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to describe the user pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest request)
AWSCognitoIdentityProviderAsync
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to describe a user pool client.public Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest request, AsyncHandler<DescribeUserPoolClientRequest,DescribeUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to describe a user pool client.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserPoolDomainResult> describeUserPoolDomainAsync(DescribeUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsync
Gets information about a domain.
describeUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
public Future<DescribeUserPoolDomainResult> describeUserPoolDomainAsync(DescribeUserPoolDomainRequest request, AsyncHandler<DescribeUserPoolDomainRequest,DescribeUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets information about a domain.
describeUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest request)
AWSCognitoIdentityProviderAsync
Forgets the specified device.
forgetDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to forget the device.public Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest request, AsyncHandler<ForgetDeviceRequest,ForgetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Forgets the specified device.
forgetDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to forget the device.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest request)
AWSCognitoIdentityProviderAsync
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.
forgotPasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to reset a user's password.public Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest request, AsyncHandler<ForgotPasswordRequest,ForgotPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
forgotPasswordAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to reset a user's password.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest request)
AWSCognitoIdentityProviderAsync
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the header information for the .csv file for the user import job.public Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest request, AsyncHandler<GetCSVHeaderRequest,GetCSVHeaderResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the header information for the .csv file for the user import job.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest request)
AWSCognitoIdentityProviderAsync
Gets the device.
getDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the device.public Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest request, AsyncHandler<GetDeviceRequest,GetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the device.
getDeviceAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get the device.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetGroupResult> getGroupAsync(GetGroupRequest request)
AWSCognitoIdentityProviderAsync
Gets a group.
Calling this action requires developer credentials.
getGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets a group.
Calling this action requires developer credentials.
getGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetIdentityProviderByIdentifierResult> getIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest request)
AWSCognitoIdentityProviderAsync
Gets the specified identity provider.
getIdentityProviderByIdentifierAsync
in interface AWSCognitoIdentityProviderAsync
public Future<GetIdentityProviderByIdentifierResult> getIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest request, AsyncHandler<GetIdentityProviderByIdentifierRequest,GetIdentityProviderByIdentifierResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the specified identity provider.
getIdentityProviderByIdentifierAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSigningCertificateResult> getSigningCertificateAsync(GetSigningCertificateRequest request)
AWSCognitoIdentityProviderAsync
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificateAsync
in interface AWSCognitoIdentityProviderAsync
request
- Request to get a signing certificate from Cognito.public Future<GetSigningCertificateResult> getSigningCertificateAsync(GetSigningCertificateRequest request, AsyncHandler<GetSigningCertificateRequest,GetSigningCertificateResult> asyncHandler)
AWSCognitoIdentityProviderAsync
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificateAsync
in interface AWSCognitoIdentityProviderAsync
request
- Request to get a signing certificate from Cognito.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetUICustomizationResult> getUICustomizationAsync(GetUICustomizationRequest request)
AWSCognitoIdentityProviderAsync
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.
getUICustomizationAsync
in interface AWSCognitoIdentityProviderAsync
public Future<GetUICustomizationResult> getUICustomizationAsync(GetUICustomizationRequest request, AsyncHandler<GetUICustomizationRequest,GetUICustomizationResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
getUICustomizationAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetUserResult> getUserAsync(GetUserRequest request)
AWSCognitoIdentityProviderAsync
Gets the user attributes and metadata for a user.
getUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get information about the user.public Future<GetUserResult> getUserAsync(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the user attributes and metadata for a user.
getUserAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get information about the user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request)
AWSCognitoIdentityProviderAsync
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get user attribute verification.public Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request, AsyncHandler<GetUserAttributeVerificationCodeRequest,GetUserAttributeVerificationCodeResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to get user attribute verification.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetUserPoolMfaConfigResult> getUserPoolMfaConfigAsync(GetUserPoolMfaConfigRequest request)
AWSCognitoIdentityProviderAsync
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigAsync
in interface AWSCognitoIdentityProviderAsync
public Future<GetUserPoolMfaConfigResult> getUserPoolMfaConfigAsync(GetUserPoolMfaConfigRequest request, AsyncHandler<GetUserPoolMfaConfigRequest,GetUserPoolMfaConfigResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest request)
AWSCognitoIdentityProviderAsync
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.
globalSignOutAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to sign out all devices.public Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest request, AsyncHandler<GlobalSignOutRequest,GlobalSignOutResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
globalSignOutAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to sign out all devices.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest request)
AWSCognitoIdentityProviderAsync
Initiates the authentication flow.
initiateAuthAsync
in interface AWSCognitoIdentityProviderAsync
request
- Initiates the authentication request.public Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest request, AsyncHandler<InitiateAuthRequest,InitiateAuthResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Initiates the authentication flow.
initiateAuthAsync
in interface AWSCognitoIdentityProviderAsync
request
- Initiates the authentication request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request)
AWSCognitoIdentityProviderAsync
Lists the devices.
listDevicesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list the devices.public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request, AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the devices.
listDevicesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list the devices.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AWSCognitoIdentityProviderAsync
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroupsAsync
in interface AWSCognitoIdentityProviderAsync
public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroupsAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIdentityProvidersResult> listIdentityProvidersAsync(ListIdentityProvidersRequest request)
AWSCognitoIdentityProviderAsync
Lists information about all identity providers for a user pool.
listIdentityProvidersAsync
in interface AWSCognitoIdentityProviderAsync
public Future<ListIdentityProvidersResult> listIdentityProvidersAsync(ListIdentityProvidersRequest request, AsyncHandler<ListIdentityProvidersRequest,ListIdentityProvidersResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists information about all identity providers for a user pool.
listIdentityProvidersAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListResourceServersResult> listResourceServersAsync(ListResourceServersRequest request)
AWSCognitoIdentityProviderAsync
Lists the resource servers for a user pool.
listResourceServersAsync
in interface AWSCognitoIdentityProviderAsync
public Future<ListResourceServersResult> listResourceServersAsync(ListResourceServersRequest request, AsyncHandler<ListResourceServersRequest,ListResourceServersResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the resource servers for a user pool.
listResourceServersAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSCognitoIdentityProviderAsync
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.
listTagsForResourceAsync
in interface AWSCognitoIdentityProviderAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
listTagsForResourceAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest request)
AWSCognitoIdentityProviderAsync
Lists the user import jobs.
listUserImportJobsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list the user import jobs.public Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest request, AsyncHandler<ListUserImportJobsRequest,ListUserImportJobsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the user import jobs.
listUserImportJobsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list the user import jobs.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest request)
AWSCognitoIdentityProviderAsync
Lists the clients that have been created for the specified user pool.
listUserPoolClientsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list the user pool clients.public Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest request, AsyncHandler<ListUserPoolClientsRequest,ListUserPoolClientsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the clients that have been created for the specified user pool.
listUserPoolClientsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list the user pool clients.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest request)
AWSCognitoIdentityProviderAsync
Lists the user pools associated with an AWS account.
listUserPoolsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list user pools.public Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest request, AsyncHandler<ListUserPoolsRequest,ListUserPoolsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the user pools associated with an AWS account.
listUserPoolsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list user pools.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AWSCognitoIdentityProviderAsync
Lists the users in the Amazon Cognito user pool.
listUsersAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list users.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the users in the Amazon Cognito user pool.
listUsersAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to list users.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersInGroupResult> listUsersInGroupAsync(ListUsersInGroupRequest request)
AWSCognitoIdentityProviderAsync
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<ListUsersInGroupResult> listUsersInGroupAsync(ListUsersInGroupRequest request, AsyncHandler<ListUsersInGroupRequest,ListUsersInGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest request)
AWSCognitoIdentityProviderAsync
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to resend the confirmation code.public Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest request, AsyncHandler<ResendConfirmationCodeRequest,ResendConfirmationCodeResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to resend the confirmation code.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest request)
AWSCognitoIdentityProviderAsync
Responds to the authentication challenge.
respondToAuthChallengeAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to respond to an authentication challenge.public Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest request, AsyncHandler<RespondToAuthChallengeRequest,RespondToAuthChallengeResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Responds to the authentication challenge.
respondToAuthChallengeAsync
in interface AWSCognitoIdentityProviderAsync
request
- The request to respond to an authentication challenge.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetRiskConfigurationResult> setRiskConfigurationAsync(SetRiskConfigurationRequest request)
AWSCognitoIdentityProviderAsync
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
.
setRiskConfigurationAsync
in interface AWSCognitoIdentityProviderAsync
public Future<SetRiskConfigurationResult> setRiskConfigurationAsync(SetRiskConfigurationRequest request, AsyncHandler<SetRiskConfigurationRequest,SetRiskConfigurationResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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
.
setRiskConfigurationAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetUICustomizationResult> setUICustomizationAsync(SetUICustomizationRequest request)
AWSCognitoIdentityProviderAsync
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.
setUICustomizationAsync
in interface AWSCognitoIdentityProviderAsync
public Future<SetUICustomizationResult> setUICustomizationAsync(SetUICustomizationRequest request, AsyncHandler<SetUICustomizationRequest,SetUICustomizationResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
setUICustomizationAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetUserMFAPreferenceResult> setUserMFAPreferenceAsync(SetUserMFAPreferenceRequest request)
AWSCognitoIdentityProviderAsync
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.
setUserMFAPreferenceAsync
in interface AWSCognitoIdentityProviderAsync
public Future<SetUserMFAPreferenceResult> setUserMFAPreferenceAsync(SetUserMFAPreferenceRequest request, AsyncHandler<SetUserMFAPreferenceRequest,SetUserMFAPreferenceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
setUserMFAPreferenceAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetUserPoolMfaConfigResult> setUserPoolMfaConfigAsync(SetUserPoolMfaConfigRequest request)
AWSCognitoIdentityProviderAsync
Set the user pool multi-factor authentication (MFA) configuration.
setUserPoolMfaConfigAsync
in interface AWSCognitoIdentityProviderAsync
public Future<SetUserPoolMfaConfigResult> setUserPoolMfaConfigAsync(SetUserPoolMfaConfigRequest request, AsyncHandler<SetUserPoolMfaConfigRequest,SetUserPoolMfaConfigResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Set the user pool multi-factor authentication (MFA) configuration.
setUserPoolMfaConfigAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest request)
AWSCognitoIdentityProviderAsync
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.
setUserSettingsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to set user settings.public Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest request, AsyncHandler<SetUserSettingsRequest,SetUserSettingsResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
setUserSettingsAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to set user settings.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SignUpResult> signUpAsync(SignUpRequest request)
AWSCognitoIdentityProviderAsync
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to register a user.public Future<SignUpResult> signUpAsync(SignUpRequest request, AsyncHandler<SignUpRequest,SignUpResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to register a user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest request)
AWSCognitoIdentityProviderAsync
Starts the user import.
startUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to start the user import job.public Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest request, AsyncHandler<StartUserImportJobRequest,StartUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Starts the user import.
startUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to start the user import job.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest request)
AWSCognitoIdentityProviderAsync
Stops the user import job.
stopUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to stop the user import job.public Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest request, AsyncHandler<StopUserImportJobRequest,StopUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Stops the user import job.
stopUserImportJobAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to stop the user import job.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSCognitoIdentityProviderAsync
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.
tagResourceAsync
in interface AWSCognitoIdentityProviderAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
tagResourceAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSCognitoIdentityProviderAsync
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
untagResourceAsync
in interface AWSCognitoIdentityProviderAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
untagResourceAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAuthEventFeedbackResult> updateAuthEventFeedbackAsync(UpdateAuthEventFeedbackRequest request)
AWSCognitoIdentityProviderAsync
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.
updateAuthEventFeedbackAsync
in interface AWSCognitoIdentityProviderAsync
public Future<UpdateAuthEventFeedbackResult> updateAuthEventFeedbackAsync(UpdateAuthEventFeedbackRequest request, AsyncHandler<UpdateAuthEventFeedbackRequest,UpdateAuthEventFeedbackResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
updateAuthEventFeedbackAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest request)
AWSCognitoIdentityProviderAsync
Updates the device status.
updateDeviceStatusAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the device status.public Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest request, AsyncHandler<UpdateDeviceStatusRequest,UpdateDeviceStatusResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Updates the device status.
updateDeviceStatusAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the device status.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AWSCognitoIdentityProviderAsync
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
updateGroupAsync
in interface AWSCognitoIdentityProviderAsync
public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
updateGroupAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateIdentityProviderResult> updateIdentityProviderAsync(UpdateIdentityProviderRequest request)
AWSCognitoIdentityProviderAsync
Updates identity provider information for a user pool.
updateIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
public Future<UpdateIdentityProviderResult> updateIdentityProviderAsync(UpdateIdentityProviderRequest request, AsyncHandler<UpdateIdentityProviderRequest,UpdateIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Updates identity provider information for a user pool.
updateIdentityProviderAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateResourceServerResult> updateResourceServerAsync(UpdateResourceServerRequest request)
AWSCognitoIdentityProviderAsync
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.
updateResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
public Future<UpdateResourceServerResult> updateResourceServerAsync(UpdateResourceServerRequest request, AsyncHandler<UpdateResourceServerRequest,UpdateResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
updateResourceServerAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest request)
AWSCognitoIdentityProviderAsync
Allows a user to update a specific attribute (one at a time).
updateUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update user attributes.public Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest request, AsyncHandler<UpdateUserAttributesRequest,UpdateUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Allows a user to update a specific attribute (one at a time).
updateUserAttributesAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update user attributes.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest request)
AWSCognitoIdentityProviderAsync
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.
updateUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the user pool.public Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest request, AsyncHandler<UpdateUserPoolRequest,UpdateUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
updateUserPoolAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the user pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest request)
AWSCognitoIdentityProviderAsync
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.
updateUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the user pool client.public Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest request, AsyncHandler<UpdateUserPoolClientRequest,UpdateUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
updateUserPoolClientAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to update the user pool client.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserPoolDomainResult> updateUserPoolDomainAsync(UpdateUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsync
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
request
- The UpdateUserPoolDomain request input.public Future<UpdateUserPoolDomainResult> updateUserPoolDomainAsync(UpdateUserPoolDomainRequest request, AsyncHandler<UpdateUserPoolDomainRequest,UpdateUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomainAsync
in interface AWSCognitoIdentityProviderAsync
request
- The UpdateUserPoolDomain request input.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<VerifySoftwareTokenResult> verifySoftwareTokenAsync(VerifySoftwareTokenRequest request)
AWSCognitoIdentityProviderAsync
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.
verifySoftwareTokenAsync
in interface AWSCognitoIdentityProviderAsync
public Future<VerifySoftwareTokenResult> verifySoftwareTokenAsync(VerifySoftwareTokenRequest request, AsyncHandler<VerifySoftwareTokenRequest,VerifySoftwareTokenResult> asyncHandler)
AWSCognitoIdentityProviderAsync
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.
verifySoftwareTokenAsync
in interface AWSCognitoIdentityProviderAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest request)
AWSCognitoIdentityProviderAsync
Verifies the specified user attributes in the user pool.
verifyUserAttributeAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to verify user attributes.public Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest request, AsyncHandler<VerifyUserAttributeRequest,VerifyUserAttributeResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Verifies the specified user attributes in the user pool.
verifyUserAttributeAsync
in interface AWSCognitoIdentityProviderAsync
request
- Represents the request to verify user attributes.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSCognitoIdentityProvider
shutdown
in class AWSCognitoIdentityProviderClient