public class AmazonCognitoIdentityProviderClient extends AmazonWebServiceClient implements AmazonCognitoIdentityProvider
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.
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Amazon Cognito Your User Pool
exceptions.
|
client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonCognitoIdentityProviderClient()
Deprecated.
|
AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account
credentials.
|
AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
and client configuration options.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider and client configuration options.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
HttpClient httpClient)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
|
AmazonCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddCustomAttributesResult |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
|
void |
adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
|
AdminConfirmSignUpResult |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code.
|
AdminCreateUserResult |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool.
|
AdminDisableProviderForUserResult |
adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)
Disables the user from signing in with the specified external (SAML or
social) identity provider.
|
void |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
AdminGetDeviceResult |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
|
AdminInitiateAuthResult |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
AdminLinkProviderForUserResult |
adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest)
Links an existing user account in a user pool (
DestinationUser ) to an identity from an external identity
provider (SourceUser ) based on a specified attribute name
and value from the external identity provider. |
AdminListDevicesResult |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
|
AdminListGroupsForUserResult |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
AdminListUserAuthEventsResult |
adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon
Cognito advanced security.
|
void |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
|
AdminRespondToAuthChallengeResult |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
|
AdminSetUserMFAPreferenceResult |
adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference.
|
AdminSetUserSettingsResult |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
Sets all the user settings for a specified user name.
|
AdminUpdateAuthEventFeedbackResult |
adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a
valid user.
|
AdminUpdateDeviceStatusResult |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
AssociateSoftwareTokenResult |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
ChangePasswordResult |
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
|
ConfirmDeviceResult |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device.
|
ConfirmForgotPasswordResult |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
|
ConfirmSignUpResult |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a
previous user.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
|
CreateIdentityProviderResult |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
|
CreateResourceServerResult |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
|
CreateUserPoolClientResult |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
|
CreateUserPoolDomainResult |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
|
void |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group.
|
void |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
|
void |
deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
|
DeleteUserAttributesResult |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
|
void |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
void |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
DeleteUserPoolDomainResult |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
|
DescribeIdentityProviderResult |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
|
DescribeResourceServerResult |
describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
|
DescribeRiskConfigurationResult |
describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
|
DescribeUserImportJobResult |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
|
DescribeUserPoolClientResult |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of
the specified user pool app client.
|
DescribeUserPoolDomainResult |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
|
void |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
|
ForgotPasswordResult |
forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Calling this API causes a message to be sent to the end user with a
confirmation code that is required to change the user's password.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
GetCSVHeaderResult |
getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)
Gets the header information for the .csv file to be used as input for the
user import job.
|
GetDeviceResult |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
|
GetGroupResult |
getGroup(GetGroupRequest getGroupRequest)
Gets a group.
|
GetIdentityProviderByIdentifierResult |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
|
GetSigningCertificateResult |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
GetUICustomizationResult |
getUICustomization(GetUICustomizationRequest getUICustomizationRequest)
Gets the UI Customization information for a particular app client's app
UI, if there is something set.
|
GetUserResult |
getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
|
GetUserAttributeVerificationCodeResult |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute
name.
|
GetUserPoolMfaConfigResult |
getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
GlobalSignOutResult |
globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
|
InitiateAuthResult |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
ListIdentityProvidersResult |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
ListResourceServersResult |
listResourceServers(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
ListUserImportJobsResult |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
|
ListUserPoolClientsResult |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
ListUsersInGroupResult |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
ResendConfirmationCodeResult |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific
user in the user pool.
|
RespondToAuthChallengeResult |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
SetRiskConfigurationResult |
setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks.
|
SetUICustomizationResult |
setUICustomization(SetUICustomizationRequest setUICustomizationRequest)
Sets the UI customization information for a user pool's built-in app UI.
|
SetUserMFAPreferenceResult |
setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference.
|
SetUserPoolMfaConfigResult |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool MFA configuration.
|
SetUserSettingsResult |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
Sets the user settings like multi-factor authentication (MFA).
|
SignUpResult |
signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name,
password, and user attributes.
|
StartUserImportJobResult |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
|
StopUserImportJobResult |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
|
UpdateAuthEventFeedbackResult |
updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a
valid user or not.
|
UpdateDeviceStatusResult |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
|
UpdateIdentityProviderResult |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
|
UpdateResourceServerResult |
updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server.
|
UpdateUserAttributesResult |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
UpdateUserPoolClientResult |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
VerifySoftwareTokenResult |
verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's
software token MFA status as "verified" if successful.
|
VerifyUserAttributeResult |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
@Deprecated public AmazonCognitoIdentityProviderClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider
that
returns AWSSessionCredentials
.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider
that
returns AWSSessionCredentials
.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).public AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider
that
returns AWSSessionCredentials
.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider
that
returns AWSSessionCredentials
.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).@Deprecated public AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration
- The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).httpClient
- A http clientpublic AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws AmazonServiceException, AmazonClientException
Adds additional user attributes to the user pool schema.
addCustomAttributes
in interface AmazonCognitoIdentityProvider
addCustomAttributesRequest
- Represents the request to add custom attributes.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserImportInProgressException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws AmazonServiceException, AmazonClientException
Adds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroup
in interface AmazonCognitoIdentityProvider
adminAddUserToGroupRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws AmazonServiceException, AmazonClientException
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUp
in interface AmazonCognitoIdentityProvider
adminConfirmSignUpRequest
- Represents the request to confirm user registration.
ResourceNotFoundException
InvalidParameterException
UnexpectedLambdaException
UserLambdaValidationException
NotAuthorizedException
TooManyFailedAttemptsException
InvalidLambdaResponseException
TooManyRequestsException
LimitExceededException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws AmazonServiceException, AmazonClientException
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 or . 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.
adminCreateUser
in interface AmazonCognitoIdentityProvider
adminCreateUserRequest
- Represents the request to create a user in the specified user pool.
ResourceNotFoundException
InvalidParameterException
UserNotFoundException
UsernameExistsException
InvalidPasswordException
CodeDeliveryFailureException
UnexpectedLambdaException
UserLambdaValidationException
InvalidLambdaResponseException
PreconditionNotMetException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
TooManyRequestsException
NotAuthorizedException
UnsupportedUserStateException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest) throws AmazonServiceException, AmazonClientException
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 .
This action is enabled only for admin access and requires developer credentials.
The ProviderName
must match the value specified when
creating an IdP for the pool.
To disable a native username + password user, the
ProviderName
value must be Cognito
and the
ProviderAttributeName
must be Cognito_Subject
,
with the ProviderAttributeValue
being the name that is used
in the user pool for the user.
The ProviderAttributeName
must always be
Cognito_Subject
for social identity providers. The
ProviderAttributeValue
must always be the exact subject that
was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked
identity has not yet been used to sign-in, the
ProviderAttributeName
and
ProviderAttributeValue
must be the same values that were
used for the SourceUser
when the identities were originally
linked in the 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.
adminDisableProviderForUser
in interface AmazonCognitoIdentityProvider
adminDisableProviderForUserRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
AliasExistsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws AmazonServiceException, AmazonClientException
Forgets the device, as an administrator.
Requires developer credentials.
adminForgetDevice
in interface AmazonCognitoIdentityProvider
adminForgetDeviceRequest
- Sends the forgot device request, as an administrator.
ResourceNotFoundException
InvalidParameterException
InvalidUserPoolConfigurationException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws AmazonServiceException, AmazonClientException
Gets the device, as an administrator.
Requires developer credentials.
adminGetDevice
in interface AmazonCognitoIdentityProvider
adminGetDeviceRequest
- Represents the request to get the device, as an administrator.
ResourceNotFoundException
InvalidParameterException
InvalidUserPoolConfigurationException
TooManyRequestsException
InternalErrorException
NotAuthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws AmazonServiceException, AmazonClientException
Initiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuth
in interface AmazonCognitoIdentityProvider
adminInitiateAuthRequest
- Initiates the authorization request, as an administrator.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
UnexpectedLambdaException
InvalidUserPoolConfigurationException
UserLambdaValidationException
InvalidLambdaResponseException
MFAMethodNotFoundException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest) throws AmazonServiceException, AmazonClientException
Links an existing user account in a user pool (
DestinationUser
) to an identity from an external identity
provider (SourceUser
) based on a specified attribute name
and value from the external identity provider. This allows you to create
a link from the existing user account to an external federated user
identity that has not yet been used to sign in, so that the federated
user identity can be used to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also .
This action is enabled only for admin access and requires developer credentials.
adminLinkProviderForUser
in interface AmazonCognitoIdentityProvider
adminLinkProviderForUserRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
AliasExistsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws AmazonServiceException, AmazonClientException
Lists devices, as an administrator.
Requires developer credentials.
adminListDevices
in interface AmazonCognitoIdentityProvider
adminListDevicesRequest
- Represents the request to list devices, as an administrator.
InvalidParameterException
ResourceNotFoundException
InvalidUserPoolConfigurationException
TooManyRequestsException
InternalErrorException
NotAuthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws AmazonServiceException, AmazonClientException
Lists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUser
in interface AmazonCognitoIdentityProvider
adminListGroupsForUserRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListUserAuthEventsResult adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws AmazonServiceException, AmazonClientException
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEvents
in interface AmazonCognitoIdentityProvider
adminListUserAuthEventsRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
UserPoolAddOnNotEnabledException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws AmazonServiceException, AmazonClientException
Removes the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroup
in interface AmazonCognitoIdentityProvider
adminRemoveUserFromGroupRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws AmazonServiceException, AmazonClientException
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallenge
in interface AmazonCognitoIdentityProvider
adminRespondToAuthChallengeRequest
- The request to respond to the authentication challenge, as an administrator.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
CodeMismatchException
ExpiredCodeException
UnexpectedLambdaException
InvalidPasswordException
UserLambdaValidationException
InvalidLambdaResponseException
TooManyRequestsException
InvalidUserPoolConfigurationException
InternalErrorException
MFAMethodNotFoundException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
AliasExistsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
SoftwareTokenMFANotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminSetUserMFAPreferenceResult adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest) throws AmazonServiceException, AmazonClientException
Sets the user's multi-factor authentication (MFA) preference.
adminSetUserMFAPreference
in interface AmazonCognitoIdentityProvider
adminSetUserMFAPreferenceRequest
- ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws AmazonServiceException, AmazonClientException
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettings
in interface AmazonCognitoIdentityProvider
adminSetUserSettingsRequest
- Represents the request to set user settings as an administrator.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUpdateAuthEventFeedbackResult adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest) throws AmazonServiceException, AmazonClientException
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.
adminUpdateAuthEventFeedback
in interface AmazonCognitoIdentityProvider
adminUpdateAuthEventFeedbackRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
UserPoolAddOnNotEnabledException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws AmazonServiceException, AmazonClientException
Updates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatus
in interface AmazonCognitoIdentityProvider
adminUpdateDeviceStatusRequest
- The request to update the device status, as an administrator.
InvalidParameterException
ResourceNotFoundException
InvalidUserPoolConfigurationException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws AmazonServiceException, AmazonClientException
Signs out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOut
in interface AmazonCognitoIdentityProvider
adminUserGlobalSignOutRequest
- The request to sign out of all devices, as an administrator.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws AmazonServiceException, AmazonClientException
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.
associateSoftwareToken
in interface AmazonCognitoIdentityProvider
associateSoftwareTokenRequest
- InvalidParameterException
NotAuthorizedException
ResourceNotFoundException
InternalErrorException
SoftwareTokenMFANotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest) throws AmazonServiceException, AmazonClientException
Changes the password for a specified user in a user pool.
changePassword
in interface AmazonCognitoIdentityProvider
changePasswordRequest
- Represents the request to change a user password.
ResourceNotFoundException
InvalidParameterException
InvalidPasswordException
NotAuthorizedException
TooManyRequestsException
LimitExceededException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws AmazonServiceException, AmazonClientException
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDevice
in interface AmazonCognitoIdentityProvider
confirmDeviceRequest
- Confirms the device request.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
InvalidPasswordException
InvalidLambdaResponseException
UsernameExistsException
InvalidUserPoolConfigurationException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws AmazonServiceException, AmazonClientException
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPassword
in interface AmazonCognitoIdentityProvider
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.
ResourceNotFoundException
UnexpectedLambdaException
UserLambdaValidationException
InvalidParameterException
InvalidPasswordException
NotAuthorizedException
CodeMismatchException
ExpiredCodeException
TooManyFailedAttemptsException
InvalidLambdaResponseException
TooManyRequestsException
LimitExceededException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws AmazonServiceException, AmazonClientException
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUp
in interface AmazonCognitoIdentityProvider
confirmSignUpRequest
- Represents the request to confirm registration of a user.
ResourceNotFoundException
InvalidParameterException
UnexpectedLambdaException
UserLambdaValidationException
NotAuthorizedException
TooManyFailedAttemptsException
CodeMismatchException
ExpiredCodeException
InvalidLambdaResponseException
AliasExistsException
TooManyRequestsException
LimitExceededException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new group in the specified user pool.
Requires developer credentials.
createGroup
in interface AmazonCognitoIdentityProvider
createGroupRequest
- InvalidParameterException
GroupExistsException
ResourceNotFoundException
TooManyRequestsException
LimitExceededException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Creates an identity provider for a user pool.
createIdentityProvider
in interface AmazonCognitoIdentityProvider
createIdentityProviderRequest
- InvalidParameterException
DuplicateProviderException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
LimitExceededException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateResourceServerResult createResourceServer(CreateResourceServerRequest createResourceServerRequest) throws AmazonServiceException, AmazonClientException
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServer
in interface AmazonCognitoIdentityProvider
createResourceServerRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
LimitExceededException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Creates the user import job.
createUserImportJob
in interface AmazonCognitoIdentityProvider
createUserImportJobRequest
- Represents the request to create the user import job.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
PreconditionNotMetException
NotAuthorizedException
LimitExceededException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Creates the user pool client.
createUserPoolClient
in interface AmazonCognitoIdentityProvider
createUserPoolClientRequest
- Represents the request to create a user pool client.
InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
LimitExceededException
NotAuthorizedException
ScopeDoesNotExistException
InvalidOAuthFlowException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws AmazonServiceException, AmazonClientException
Creates a new domain for a user pool.
createUserPoolDomain
in interface AmazonCognitoIdentityProvider
createUserPoolDomainRequest
- InvalidParameterException
NotAuthorizedException
ResourceNotFoundException
LimitExceededException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteGroup(DeleteGroupRequest deleteGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroup
in interface AmazonCognitoIdentityProvider
deleteGroupRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Deletes an identity provider for a user pool.
deleteIdentityProvider
in interface AmazonCognitoIdentityProvider
deleteIdentityProviderRequest
- InvalidParameterException
UnsupportedIdentityProviderException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest) throws AmazonServiceException, AmazonClientException
Deletes a resource server.
deleteResourceServer
in interface AmazonCognitoIdentityProvider
deleteResourceServerRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonServiceException, AmazonClientException
Allows a user to delete himself or herself.
deleteUser
in interface AmazonCognitoIdentityProvider
deleteUserRequest
- Represents the request to delete a user.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Deletes the attributes for a user.
deleteUserAttributes
in interface AmazonCognitoIdentityProvider
deleteUserAttributesRequest
- Represents the request to delete user attributes.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified Amazon Cognito user pool.
deleteUserPool
in interface AmazonCognitoIdentityProvider
deleteUserPoolRequest
- Represents the request to delete a user pool.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserImportInProgressException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Allows the developer to delete the user pool client.
deleteUserPoolClient
in interface AmazonCognitoIdentityProvider
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws AmazonServiceException, AmazonClientException
Deletes a domain for a user pool.
deleteUserPoolDomain
in interface AmazonCognitoIdentityProvider
deleteUserPoolDomainRequest
- NotAuthorizedException
InvalidParameterException
ResourceNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Gets information about a specific identity provider.
describeIdentityProvider
in interface AmazonCognitoIdentityProvider
describeIdentityProviderRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest) throws AmazonServiceException, AmazonClientException
Describes a resource server.
describeResourceServer
in interface AmazonCognitoIdentityProvider
describeResourceServerRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeRiskConfigurationResult describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest) throws AmazonServiceException, AmazonClientException
Describes the risk configuration.
describeRiskConfiguration
in interface AmazonCognitoIdentityProvider
describeRiskConfigurationRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserPoolAddOnNotEnabledException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Describes the user import job.
describeUserImportJob
in interface AmazonCognitoIdentityProvider
describeUserImportJobRequest
- Represents the request to describe the user import job.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClient
in interface AmazonCognitoIdentityProvider
describeUserPoolClientRequest
- Represents the request to describe a user pool client.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws AmazonServiceException, AmazonClientException
Gets information about a domain.
describeUserPoolDomain
in interface AmazonCognitoIdentityProvider
describeUserPoolDomainRequest
- NotAuthorizedException
InvalidParameterException
ResourceNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws AmazonServiceException, AmazonClientException
Forgets the specified device.
forgetDevice
in interface AmazonCognitoIdentityProvider
forgetDeviceRequest
- Represents the request to forget the device.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
InvalidUserPoolConfigurationException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws AmazonServiceException, AmazonClientException
Calling this API causes a message to be sent to the end user with a
confirmation code that is required to change the user's password. For the
Username
parameter, you can use the username or user alias.
If a verified phone number exists for the user, the confirmation code is
sent to the phone number. Otherwise, if a verified email exists, the
confirmation code is sent to the email. If neither a verified phone
number nor a verified email exists,
InvalidParameterException
is thrown. To use the confirmation
code for resetting the password, call .
forgotPassword
in interface AmazonCognitoIdentityProvider
forgotPasswordRequest
- Represents the request to reset a user's password.
ResourceNotFoundException
InvalidParameterException
UnexpectedLambdaException
UserLambdaValidationException
NotAuthorizedException
InvalidLambdaResponseException
TooManyRequestsException
LimitExceededException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
InvalidEmailRoleAccessPolicyException
CodeDeliveryFailureException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) throws AmazonServiceException, AmazonClientException
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeader
in interface AmazonCognitoIdentityProvider
getCSVHeaderRequest
- Represents the request to get the header information for the .csv file for the user import job.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest) throws AmazonServiceException, AmazonClientException
Gets the device.
getDevice
in interface AmazonCognitoIdentityProvider
getDeviceRequest
- Represents the request to get the device.
ResourceNotFoundException
InvalidParameterException
InvalidUserPoolConfigurationException
NotAuthorizedException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetGroupResult getGroup(GetGroupRequest getGroupRequest) throws AmazonServiceException, AmazonClientException
Gets a group.
Requires developer credentials.
getGroup
in interface AmazonCognitoIdentityProvider
getGroupRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws AmazonServiceException, AmazonClientException
Gets the specified identity provider.
getIdentityProviderByIdentifier
in interface AmazonCognitoIdentityProvider
getIdentityProviderByIdentifierRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetSigningCertificateResult getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest) throws AmazonServiceException, AmazonClientException
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificate
in interface AmazonCognitoIdentityProvider
getSigningCertificateRequest
- Request to get a signing certificate from Cognito.
InternalErrorException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUICustomizationResult getUICustomization(GetUICustomizationRequest getUICustomizationRequest) throws AmazonServiceException, AmazonClientException
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.
getUICustomization
in interface AmazonCognitoIdentityProvider
getUICustomizationRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserResult getUser(GetUserRequest getUserRequest) throws AmazonServiceException, AmazonClientException
Gets the user attributes and metadata for a user.
getUser
in interface AmazonCognitoIdentityProvider
getUserRequest
- Represents the request to get information about the user.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws AmazonServiceException, AmazonClientException
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCode
in interface AmazonCognitoIdentityProvider
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UnexpectedLambdaException
UserLambdaValidationException
InvalidLambdaResponseException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
InvalidEmailRoleAccessPolicyException
CodeDeliveryFailureException
LimitExceededException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserPoolMfaConfigResult getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest) throws AmazonServiceException, AmazonClientException
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfig
in interface AmazonCognitoIdentityProvider
getUserPoolMfaConfigRequest
- InvalidParameterException
TooManyRequestsException
ResourceNotFoundException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws AmazonServiceException, AmazonClientException
Signs out users from all devices.
globalSignOut
in interface AmazonCognitoIdentityProvider
globalSignOutRequest
- Represents the request to sign out all devices.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
PasswordResetRequiredException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest) throws AmazonServiceException, AmazonClientException
Initiates the authentication flow.
initiateAuth
in interface AmazonCognitoIdentityProvider
initiateAuthRequest
- Initiates the authentication request.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
TooManyRequestsException
UnexpectedLambdaException
InvalidUserPoolConfigurationException
UserLambdaValidationException
InvalidLambdaResponseException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest) throws AmazonServiceException, AmazonClientException
Lists the devices.
listDevices
in interface AmazonCognitoIdentityProvider
listDevicesRequest
- Represents the request to list the devices.
InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InvalidUserPoolConfigurationException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest) throws AmazonServiceException, AmazonClientException
Lists the groups associated with a user pool.
Requires developer credentials.
listGroups
in interface AmazonCognitoIdentityProvider
listGroupsRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws AmazonServiceException, AmazonClientException
Lists information about all identity providers for a user pool.
listIdentityProviders
in interface AmazonCognitoIdentityProvider
listIdentityProvidersRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListResourceServersResult listResourceServers(ListResourceServersRequest listResourceServersRequest) throws AmazonServiceException, AmazonClientException
Lists the resource servers for a user pool.
listResourceServers
in interface AmazonCognitoIdentityProvider
listResourceServersRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws AmazonServiceException, AmazonClientException
Lists the user import jobs.
listUserImportJobs
in interface AmazonCognitoIdentityProvider
listUserImportJobsRequest
- Represents the request to list the user import jobs.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws AmazonServiceException, AmazonClientException
Lists the clients that have been created for the specified user pool.
listUserPoolClients
in interface AmazonCognitoIdentityProvider
listUserPoolClientsRequest
- Represents the request to list the user pool clients.
InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonServiceException, AmazonClientException
Lists the users in the Amazon Cognito user pool.
listUsers
in interface AmazonCognitoIdentityProvider
listUsersRequest
- Represents the request to list users.
InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws AmazonServiceException, AmazonClientException
Lists the users in the specified group.
Requires developer credentials.
listUsersInGroup
in interface AmazonCognitoIdentityProvider
listUsersInGroupRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws AmazonServiceException, AmazonClientException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCode
in interface AmazonCognitoIdentityProvider
resendConfirmationCodeRequest
- Represents the request to resend the confirmation code.
ResourceNotFoundException
InvalidParameterException
UnexpectedLambdaException
UserLambdaValidationException
NotAuthorizedException
InvalidLambdaResponseException
TooManyRequestsException
LimitExceededException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
InvalidEmailRoleAccessPolicyException
CodeDeliveryFailureException
UserNotFoundException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws AmazonServiceException, AmazonClientException
Responds to the authentication challenge.
respondToAuthChallenge
in interface AmazonCognitoIdentityProvider
respondToAuthChallengeRequest
- The request to respond to an authentication challenge.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
CodeMismatchException
ExpiredCodeException
UnexpectedLambdaException
UserLambdaValidationException
InvalidPasswordException
InvalidLambdaResponseException
TooManyRequestsException
InvalidUserPoolConfigurationException
MFAMethodNotFoundException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
AliasExistsException
InternalErrorException
SoftwareTokenMFANotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetRiskConfigurationResult setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest) throws AmazonServiceException, AmazonClientException
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
key
AdvancedSecurityMode
.
See .
setRiskConfiguration
in interface AmazonCognitoIdentityProvider
setRiskConfigurationRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
UserPoolAddOnNotEnabledException
CodeDeliveryFailureException
InvalidEmailRoleAccessPolicyException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUICustomizationResult setUICustomization(SetUICustomizationRequest setUICustomizationRequest) throws AmazonServiceException, AmazonClientException
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.
setUICustomization
in interface AmazonCognitoIdentityProvider
setUICustomizationRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest) throws AmazonServiceException, AmazonClientException
Set the user's multi-factor authentication (MFA) method preference.
setUserMFAPreference
in interface AmazonCognitoIdentityProvider
setUserMFAPreferenceRequest
- ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserPoolMfaConfigResult setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest) throws AmazonServiceException, AmazonClientException
Set the user pool MFA configuration.
setUserPoolMfaConfig
in interface AmazonCognitoIdentityProvider
setUserPoolMfaConfigRequest
- InvalidParameterException
TooManyRequestsException
ResourceNotFoundException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws AmazonServiceException, AmazonClientException
Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
setUserSettings
in interface AmazonCognitoIdentityProvider
setUserSettingsRequest
- Represents the request to set user settings.
ResourceNotFoundException
InvalidParameterException
NotAuthorizedException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SignUpResult signUp(SignUpRequest signUpRequest) throws AmazonServiceException, AmazonClientException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUp
in interface AmazonCognitoIdentityProvider
signUpRequest
- Represents the request to register a user.
ResourceNotFoundException
InvalidParameterException
UnexpectedLambdaException
UserLambdaValidationException
NotAuthorizedException
InvalidPasswordException
InvalidLambdaResponseException
UsernameExistsException
TooManyRequestsException
InternalErrorException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
InvalidEmailRoleAccessPolicyException
CodeDeliveryFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Starts the user import.
startUserImportJob
in interface AmazonCognitoIdentityProvider
startUserImportJobRequest
- Represents the request to start the user import job.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
InternalErrorException
PreconditionNotMetException
NotAuthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Stops the user import job.
stopUserImportJob
in interface AmazonCognitoIdentityProvider
stopUserImportJobRequest
- Represents the request to stop the user import job.
ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
InternalErrorException
PreconditionNotMetException
NotAuthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateAuthEventFeedbackResult updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest) throws AmazonServiceException, AmazonClientException
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.
updateAuthEventFeedback
in interface AmazonCognitoIdentityProvider
updateAuthEventFeedbackRequest
- InvalidParameterException
ResourceNotFoundException
TooManyRequestsException
NotAuthorizedException
UserNotFoundException
UserPoolAddOnNotEnabledException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws AmazonServiceException, AmazonClientException
Updates the device status.
updateDeviceStatus
in interface AmazonCognitoIdentityProvider
updateDeviceStatusRequest
- Represents the request to update the device status.
InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InvalidUserPoolConfigurationException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest) throws AmazonServiceException, AmazonClientException
Updates the specified group with the specified attributes.
Requires developer credentials.
updateGroup
in interface AmazonCognitoIdentityProvider
updateGroupRequest
- ResourceNotFoundException
InvalidParameterException
TooManyRequestsException
NotAuthorizedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Updates identity provider information for a user pool.
updateIdentityProvider
in interface AmazonCognitoIdentityProvider
updateIdentityProviderRequest
- InvalidParameterException
UnsupportedIdentityProviderException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest) throws AmazonServiceException, AmazonClientException
Updates the name and scopes of resource server. All other fields are read-only.
updateResourceServer
in interface AmazonCognitoIdentityProvider
updateResourceServerRequest
- InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
TooManyRequestsException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a user to update a specific attribute (one at a time).
updateUserAttributes
in interface AmazonCognitoIdentityProvider
updateUserAttributesRequest
- Represents the request to update user attributes.
ResourceNotFoundException
InvalidParameterException
CodeMismatchException
ExpiredCodeException
NotAuthorizedException
UnexpectedLambdaException
UserLambdaValidationException
InvalidLambdaResponseException
TooManyRequestsException
AliasExistsException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
InvalidEmailRoleAccessPolicyException
CodeDeliveryFailureException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Updates the specified user pool app client with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool app client settings with .
updateUserPoolClient
in interface AmazonCognitoIdentityProvider
updateUserPoolClientRequest
- Represents the request to update the user pool client.
ResourceNotFoundException
InvalidParameterException
ConcurrentModificationException
TooManyRequestsException
NotAuthorizedException
ScopeDoesNotExistException
InvalidOAuthFlowException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws AmazonServiceException, AmazonClientException
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.
verifySoftwareToken
in interface AmazonCognitoIdentityProvider
verifySoftwareTokenRequest
- InvalidParameterException
ResourceNotFoundException
InvalidUserPoolConfigurationException
NotAuthorizedException
TooManyRequestsException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
EnableSoftwareTokenMFAException
NotAuthorizedException
SoftwareTokenMFANotFoundException
CodeMismatchException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws AmazonServiceException, AmazonClientException
Verifies the specified user attributes in the user pool.
verifyUserAttribute
in interface AmazonCognitoIdentityProvider
verifyUserAttributeRequest
- Represents the request to verify user attributes.
ResourceNotFoundException
InvalidParameterException
CodeMismatchException
ExpiredCodeException
NotAuthorizedException
TooManyRequestsException
LimitExceededException
PasswordResetRequiredException
UserNotFoundException
UserNotConfirmedException
InternalErrorException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.@Deprecated public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonCognitoIdentityProvider
request
- The originally executed requestCopyright © 2019. All rights reserved.