AWS SDK for PHP 3.x
  • Namespace
  • Class
Did this page help you? SUBMIT FEEDBACK!

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • Batch
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • Endpoint
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • Kafka
      • Exception
    • kendra
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexRuntimeService
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutforVision
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • ManagedBlockchain
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Schemas
      • Exception
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Exceptions

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

Class CognitoIdentityProviderException

Exception
Extended by RuntimeException
Extended by Aws\Exception\AwsException implements Aws\MonitoringEventsInterface, Aws\ResponseContainerInterface, ArrayAccess uses Aws\HasDataTrait, Aws\HasMonitoringEventsTrait
Extended by 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

appendMonitoringEvent(), getMonitoringEvents(), prependMonitoringEvent()

Methods used from Aws\HasDataTrait

count(), getIterator(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), toArray()

Methods used from Aws\HasMonitoringEventsTrait

appendMonitoringEvent(), getMonitoringEvents(), prependMonitoringEvent()

Expected Exception Codes

The following are the known exception codes and corresponding data shapes that this service may return as part of an error response.

AliasExistsException

[
    'message' => '<string>',
]
Description

This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

Members
message
  • Type: string

The message sent to the user when an alias exists.

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 does not 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.

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 is not 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 is not set on an email address that Amazon Cognito can access.

InvalidLambdaResponseException

[
    'message' => '<string>',
]
Description

This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

Members
message
  • Type: string

The message returned when the Amazon Cognito service throws an invalid AWS Lambda response exception.

InvalidOAuthFlowException

[
    'message' => '<string>',
]
Description

This exception is thrown when the specified OAuth flow is invalid.

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 the Amazon Cognito service encounters an invalid password.

Members
message
  • Type: string

The message returned when the Amazon Cognito service throws an invalid user password exception.

InvalidSmsRoleAccessPolicyException

[
    'message' => '<string>',
]
Description

This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.

Members
message
  • Type: string

The message retuned when the invalid SMS role access policy exception is thrown.

InvalidSmsRoleTrustRelationshipException

[
    'message' => '<string>',
]
Description

This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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 invalid.

InvalidUserPoolConfigurationException

[
    'message' => '<string>',
]
Description

This exception is thrown when the user pool configuration is invalid.

Members
message
  • Type: string

The message returned when the user pool configuration is invalid.

LimitExceededException

[
    'message' => '<string>',
]
Description

This exception is thrown when a user exceeds the limit for a requested AWS 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 cannot 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 is not 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 cannot 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 does not exist.

Members
message
  • Type: string

SoftwareTokenMFANotFoundException

[
    'message' => '<string>',
]
Description

This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled 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 (e.g., sign in).

Members
message
  • Type: string

The message returned when the Amazon Cognito service returns a too many failed attempts exception.

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.

UnexpectedLambdaException

[
    'message' => '<string>',
]
Description

This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

Members
message
  • Type: string

The message returned when the Amazon Cognito service returns an unexpected AWS Lambda exception.

UnsupportedIdentityProviderException

[
    'message' => '<string>',
]
Description

This exception is thrown when the specified identifier is not supported.

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 are 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 AWS Lambda service.

Members
message
  • Type: string

The message returned when the Amazon Cognito service returns a user validation exception with the AWS Lambda service.

UserNotConfirmedException

[
    'message' => '<string>',
]
Description

This exception is thrown when a user is not confirmed successfully.

Members
message
  • Type: string

The message returned when a user is not confirmed successfully.

UserNotFoundException

[
    'message' => '<string>',
]
Description

This exception is thrown when a user is not found.

Members
message
  • Type: string

The message returned when a user is not found.

UserPoolAddOnNotEnabledException

[
    'message' => '<string>',
]
Description

This exception is thrown when user pool add-ons are not enabled.

Members
message
  • Type: string

UserPoolTaggingException

[
    'message' => '<string>',
]
Description

This exception is thrown when a user pool tag cannot 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.

AWS SDK for PHP 3.x API documentation generated by ApiGen