Class CognitoIdentityProviderException
- Exception
-
RuntimeException
-
Aws\Exception\AwsException
implements
Aws\MonitoringEventsInterface,
Aws\ResponseContainerInterface,
ArrayAccess
uses
Aws\HasDataTrait,
Aws\HasMonitoringEventsTrait
-
Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
- Namespace: Aws\CognitoIdentityProvider\Exception
- Located at CognitoIdentityProvider/Exception/CognitoIdentityProviderException.php
Represents an error interacting with the Amazon Cognito Identity Provider service.
Methods Summary
Methods inherited from Aws\Exception\AwsException
__construct(),
__toString(),
get(),
getAwsErrorCode(),
getAwsErrorMessage(),
getAwsErrorShape(),
getAwsErrorType(),
getAwsRequestId(),
getCommand(),
getRequest(),
getResponse(),
getResult(),
getStatusCode(),
getTransferInfo(),
hasKey(),
isConnectionError(),
isMaxRetriesExceeded(),
search(),
setMaxRetriesExceeded(),
setTransferInfo()
Methods inherited from Exception
__wakeup(),
getCode(),
getFile(),
getLine(),
getMessage(),
getPrevious(),
getTrace(),
getTraceAsString()
Methods inherited from ArrayAccess
offsetExists(),
offsetGet(),
offsetSet(),
offsetUnset()
Methods inherited from Aws\MonitoringEventsInterface
Methods used from Aws\HasDataTrait
Methods used from Aws\HasMonitoringEventsTrait
Expected Exception Codes
AliasExistsException
[
'message' => '<string>',
]
Description
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
Members
- message
-
- Type: string
The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.
CodeDeliveryFailureException
[
'message' => '<string>',
]
Description
This exception is thrown when a verification code fails to deliver successfully.
Members
- message
-
- Type: string
The message sent when a verification code fails to deliver successfully.
CodeMismatchException
[
'message' => '<string>',
]
Description
This exception is thrown if the provided code doesn't match what the server was expecting.
Members
- message
-
- Type: string
The message provided when the code mismatch exception is thrown.
ConcurrentModificationException
[
'message' => '<string>',
]
Description
This exception is thrown if two or more modifications are happening concurrently.
Members
- message
-
- Type: string
The message provided when the concurrent exception is thrown.
DuplicateProviderException
[
'message' => '<string>',
]
Description
This exception is thrown when the provider is already supported by the user pool.
Members
- message
-
- Type: string
EnableSoftwareTokenMFAException
[
'message' => '<string>',
]
Description
This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
Members
- message
-
- Type: string
ExpiredCodeException
[
'message' => '<string>',
]
Description
This exception is thrown if a code has expired.
Members
- message
-
- Type: string
The message returned when the expired code exception is thrown.
ForbiddenException
[
'message' => '<string>',
]
Description
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
Members
- message
-
- Type: string
The message returned when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
GroupExistsException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
Members
- message
-
- Type: string
InternalErrorException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito encounters an internal error.
Members
- message
-
- Type: string
The message returned when Amazon Cognito throws an internal error exception.
InvalidEmailRoleAccessPolicyException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
Members
- message
-
- Type: string
The message returned when you have an unverified email address or the identity policy isn't set on an email address that Amazon Cognito can access.
InvalidLambdaResponseException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
Members
- message
-
- Type: string
The message returned when Amazon Cognito throws an invalid Lambda response exception.
InvalidOAuthFlowException
[
'message' => '<string>',
]
Description
This exception is thrown when the specified OAuth flow is not valid.
Members
- message
-
- Type: string
InvalidParameterException
[
'message' => '<string>',
]
Description
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
Members
- message
-
- Type: string
The message returned when the Amazon Cognito service throws an invalid parameter exception.
InvalidPasswordException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito encounters an invalid password.
Members
- message
-
- Type: string
The message returned when Amazon Cognito throws an invalid user password exception.
InvalidSmsRoleAccessPolicyException
[
'message' => '<string>',
]
Description
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
Members
- message
-
- Type: string
The message returned when the invalid SMS role access policy exception is thrown.
InvalidSmsRoleTrustRelationshipException
[
'message' => '<string>',
]
Description
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
Members
- message
-
- Type: string
The message returned when the role trust relationship for the SMS message is not valid.
InvalidUserPoolConfigurationException
[
'message' => '<string>',
]
Description
This exception is thrown when the user pool configuration is not valid.
Members
- message
-
- Type: string
The message returned when the user pool configuration is not valid.
LimitExceededException
[
'message' => '<string>',
]
Description
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
Members
- message
-
- Type: string
The message returned when Amazon Cognito throws a limit exceeded exception.
MFAMethodNotFoundException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
Members
- message
-
- Type: string
The message returned when Amazon Cognito throws an MFA method not found exception.
NotAuthorizedException
[
'message' => '<string>',
]
Description
This exception is thrown when a user isn't authorized.
Members
- message
-
- Type: string
The message returned when the Amazon Cognito service returns a not authorized exception.
PasswordResetRequiredException
[
'message' => '<string>',
]
Description
This exception is thrown when a password reset is required.
Members
- message
-
- Type: string
The message returned when a password reset is required.
PreconditionNotMetException
[
'message' => '<string>',
]
Description
This exception is thrown when a precondition is not met.
Members
- message
-
- Type: string
The message returned when a precondition is not met.
ResourceNotFoundException
[
'message' => '<string>',
]
Description
This exception is thrown when the Amazon Cognito service can't find the requested resource.
Members
- message
-
- Type: string
The message returned when the Amazon Cognito service returns a resource not found exception.
ScopeDoesNotExistException
[
'message' => '<string>',
]
Description
This exception is thrown when the specified scope doesn't exist.
Members
- message
-
- Type: string
SoftwareTokenMFANotFoundException
[
'message' => '<string>',
]
Description
This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
Members
- message
-
- Type: string
TooManyFailedAttemptsException
[
'message' => '<string>',
]
Description
This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
Members
- message
-
- Type: string
The message returned when Amazon Cognito returns a
TooManyFailedAttemptsexception.
TooManyRequestsException
[
'message' => '<string>',
]
Description
This exception is thrown when the user has made too many requests for a given operation.
Members
- message
-
- Type: string
The message returned when the Amazon Cognito service returns a too many requests exception.
UnauthorizedException
[
'message' => '<string>',
]
Description
Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.
Members
- message
-
- Type: string
UnexpectedLambdaException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
Members
- message
-
- Type: string
The message returned when Amazon Cognito returns an unexpected Lambda exception.
UnsupportedIdentityProviderException
[
'message' => '<string>',
]
Description
This exception is thrown when the specified identifier isn't supported.
Members
- message
-
- Type: string
UnsupportedOperationException
[
'message' => '<string>',
]
Description
Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.
Members
- message
-
- Type: string
UnsupportedTokenTypeException
[
'message' => '<string>',
]
Description
Exception that is thrown when an unsupported token is passed to an operation.
Members
- message
-
- Type: string
UnsupportedUserStateException
[
'message' => '<string>',
]
Description
The request failed because the user is in an unsupported state.
Members
- message
-
- Type: string
The message returned when the user is in an unsupported state.
UserImportInProgressException
[
'message' => '<string>',
]
Description
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
Members
- message
-
- Type: string
The message returned when the user pool has an import job running.
UserLambdaValidationException
[
'message' => '<string>',
]
Description
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
Members
- message
-
- Type: string
The message returned when the Amazon Cognito service returns a user validation exception with the Lambda service.
UserNotConfirmedException
[
'message' => '<string>',
]
Description
This exception is thrown when a user isn't confirmed successfully.
Members
- message
-
- Type: string
The message returned when a user isn't confirmed successfully.
UserNotFoundException
[
'message' => '<string>',
]
Description
This exception is thrown when a user isn't found.
Members
- message
-
- Type: string
The message returned when a user isn't found.
UserPoolAddOnNotEnabledException
[
'message' => '<string>',
]
Description
This exception is thrown when user pool add-ons aren't enabled.
Members
- message
-
- Type: string
UserPoolTaggingException
[
'message' => '<string>',
]
Description
This exception is thrown when a user pool tag can't be set or updated.
Members
- message
-
- Type: string
UsernameExistsException
[
'message' => '<string>',
]
Description
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
Members
- message
-
- Type: string
The message returned when Amazon Cognito throws a user name exists exception.