{-# LANGUAGE OverloadedStrings #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.CognitoIdentityProvider.Types -- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- module Network.AWS.CognitoIdentityProvider.Types ( -- * Service Configuration cognitoIdentityProvider -- * Errors , _UnsupportedUserStateException , _PasswordResetRequiredException , _InvalidParameterException , _InvalidLambdaResponseException , _InvalidEmailRoleAccessPolicyException , _UnsupportedIdentityProviderException , _UserNotFoundException , _UnexpectedLambdaException , _NotAuthorizedException , _InternalErrorException , _InvalidUserPoolConfigurationException , _InvalidSmsRoleAccessPolicyException , _InvalidOAuthFlowException , _CodeMismatchException , _UserImportInProgressException , _InvalidSmsRoleTrustRelationshipException , _UserPoolTaggingException , _TooManyRequestsException , _ConcurrentModificationException , _UserLambdaValidationException , _PreconditionNotMetException , _ExpiredCodeException , _TooManyFailedAttemptsException , _UserNotConfirmedException , _GroupExistsException , _CodeDeliveryFailureException , _ScopeDoesNotExistException , _ResourceNotFoundException , _MFAMethodNotFoundException , _AliasExistsException , _DuplicateProviderException , _LimitExceededException , _InvalidPasswordException , _UsernameExistsException -- * AliasAttributeType , AliasAttributeType (..) -- * AttributeDataType , AttributeDataType (..) -- * AuthFlowType , AuthFlowType (..) -- * ChallengeNameType , ChallengeNameType (..) -- * DefaultEmailOptionType , DefaultEmailOptionType (..) -- * DeliveryMediumType , DeliveryMediumType (..) -- * DeviceRememberedStatusType , DeviceRememberedStatusType (..) -- * DomainStatusType , DomainStatusType (..) -- * ExplicitAuthFlowsType , ExplicitAuthFlowsType (..) -- * IdentityProviderTypeType , IdentityProviderTypeType (..) -- * MessageActionType , MessageActionType (..) -- * OAuthFlowType , OAuthFlowType (..) -- * StatusType , StatusType (..) -- * UserImportJobStatusType , UserImportJobStatusType (..) -- * UserPoolMFAType , UserPoolMFAType (..) -- * UserStatusType , UserStatusType (..) -- * UsernameAttributeType , UsernameAttributeType (..) -- * VerifiedAttributeType , VerifiedAttributeType (..) -- * AdminCreateUserConfigType , AdminCreateUserConfigType , adminCreateUserConfigType , acuctAllowAdminCreateUserOnly , acuctUnusedAccountValidityDays , acuctInviteMessageTemplate -- * AttributeType , AttributeType , attributeType , atValue , atName -- * AuthenticationResultType , AuthenticationResultType , authenticationResultType , artAccessToken , artRefreshToken , artNewDeviceMetadata , artExpiresIn , artTokenType , artIdToken -- * CodeDeliveryDetailsType , CodeDeliveryDetailsType , codeDeliveryDetailsType , cddtDestination , cddtDeliveryMedium , cddtAttributeName -- * DeviceConfigurationType , DeviceConfigurationType , deviceConfigurationType , dctChallengeRequiredOnNewDevice , dctDeviceOnlyRememberedOnUserPrompt -- * DeviceSecretVerifierConfigType , DeviceSecretVerifierConfigType , deviceSecretVerifierConfigType , dsvctPasswordVerifier , dsvctSalt -- * DeviceType , DeviceType , deviceType , dtDeviceLastModifiedDate , dtDeviceCreateDate , dtDeviceAttributes , dtDeviceKey , dtDeviceLastAuthenticatedDate -- * DomainDescriptionType , DomainDescriptionType , domainDescriptionType , ddtStatus , ddtCloudFrontDistribution , ddtUserPoolId , ddtDomain , ddtAWSAccountId , ddtVersion , ddtS3Bucket -- * EmailConfigurationType , EmailConfigurationType , emailConfigurationType , ectSourceARN , ectReplyToEmailAddress -- * GroupType , GroupType , groupType , gtLastModifiedDate , gtUserPoolId , gtCreationDate , gtPrecedence , gtGroupName , gtDescription , gtRoleARN -- * IdentityProviderType , IdentityProviderType , identityProviderType , iptLastModifiedDate , iptUserPoolId , iptProviderType , iptCreationDate , iptIdpIdentifiers , iptAttributeMapping , iptProviderDetails , iptProviderName -- * LambdaConfigType , LambdaConfigType , lambdaConfigType , lctPreAuthentication , lctCreateAuthChallenge , lctVerifyAuthChallengeResponse , lctPostAuthentication , lctCustomMessage , lctDefineAuthChallenge , lctPostConfirmation , lctPreSignUp -- * MFAOptionType , MFAOptionType , mfaOptionType , motDeliveryMedium , motAttributeName -- * MessageTemplateType , MessageTemplateType , messageTemplateType , mttEmailSubject , mttSMSMessage , mttEmailMessage -- * NewDeviceMetadataType , NewDeviceMetadataType , newDeviceMetadataType , ndmtDeviceGroupKey , ndmtDeviceKey -- * NumberAttributeConstraintsType , NumberAttributeConstraintsType , numberAttributeConstraintsType , nactMaxValue , nactMinValue -- * PasswordPolicyType , PasswordPolicyType , passwordPolicyType , pptRequireNumbers , pptRequireUppercase , pptRequireLowercase , pptMinimumLength , pptRequireSymbols -- * ProviderDescription , ProviderDescription , providerDescription , pdLastModifiedDate , pdProviderType , pdCreationDate , pdProviderName -- * ProviderUserIdentifierType , ProviderUserIdentifierType , providerUserIdentifierType , puitProviderAttributeValue , puitProviderAttributeName , puitProviderName -- * ResourceServerScopeType , ResourceServerScopeType , resourceServerScopeType , rsstScopeName , rsstScopeDescription -- * ResourceServerType , ResourceServerType , resourceServerType , rstUserPoolId , rstIdentifier , rstScopes , rstName -- * SchemaAttributeType , SchemaAttributeType , schemaAttributeType , satNumberAttributeConstraints , satRequired , satAttributeDataType , satStringAttributeConstraints , satName , satDeveloperOnlyAttribute , satMutable -- * SmsConfigurationType , SmsConfigurationType , smsConfigurationType , sctExternalId , sctSNSCallerARN -- * StringAttributeConstraintsType , StringAttributeConstraintsType , stringAttributeConstraintsType , sactMaxLength , sactMinLength -- * UICustomizationType , UICustomizationType , uICustomizationType , uictClientId , uictLastModifiedDate , uictUserPoolId , uictCSS , uictCSSVersion , uictImageURL , uictCreationDate -- * UserImportJobType , UserImportJobType , userImportJobType , uijtStatus , uijtSkippedUsers , uijtJobId , uijtUserPoolId , uijtJobName , uijtPreSignedURL , uijtFailedUsers , uijtStartDate , uijtCompletionMessage , uijtCreationDate , uijtCompletionDate , uijtCloudWatchLogsRoleARN , uijtImportedUsers -- * UserPoolClientDescription , UserPoolClientDescription , userPoolClientDescription , upcdClientId , upcdUserPoolId , upcdClientName -- * UserPoolClientType , UserPoolClientType , userPoolClientType , upctRefreshTokenValidity , upctClientId , upctExplicitAuthFlows , upctClientSecret , upctLastModifiedDate , upctSupportedIdentityProviders , upctLogoutURLs , upctAllowedOAuthFlowsUserPoolClient , upctUserPoolId , upctDefaultRedirectURI , upctWriteAttributes , upctCreationDate , upctReadAttributes , upctAllowedOAuthScopes , upctAllowedOAuthFlows , upctClientName , upctCallbackURLs -- * UserPoolDescriptionType , UserPoolDescriptionType , userPoolDescriptionType , updtStatus , updtLastModifiedDate , updtName , updtId , updtCreationDate , updtLambdaConfig -- * UserPoolPolicyType , UserPoolPolicyType , userPoolPolicyType , upptPasswordPolicy -- * UserPoolType , UserPoolType , userPoolType , uptStatus , uptUserPoolTags , uptEmailConfigurationFailure , uptLastModifiedDate , uptVerificationMessageTemplate , uptEstimatedNumberOfUsers , uptEmailVerificationMessage , uptSmsAuthenticationMessage , uptSchemaAttributes , uptEmailVerificationSubject , uptUsernameAttributes , uptAliasAttributes , uptEmailConfiguration , uptSmsVerificationMessage , uptName , uptMFAConfiguration , uptId , uptSmsConfigurationFailure , uptCreationDate , uptLambdaConfig , uptSmsConfiguration , uptAdminCreateUserConfig , uptDeviceConfiguration , uptAutoVerifiedAttributes , uptPolicies -- * UserType , UserType , userType , utEnabled , utUserStatus , utUsername , utUserCreateDate , utAttributes , utMFAOptions , utUserLastModifiedDate -- * VerificationMessageTemplateType , VerificationMessageTemplateType , verificationMessageTemplateType , vmttDefaultEmailOption , vmttEmailSubject , vmttEmailSubjectByLink , vmttSmsMessage , vmttEmailMessageByLink , vmttEmailMessage ) where import Network.AWS.CognitoIdentityProvider.Types.Product import Network.AWS.CognitoIdentityProvider.Types.Sum import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Sign.V4 -- | API version @2016-04-18@ of the Amazon Cognito Identity Provider SDK configuration. cognitoIdentityProvider :: Service cognitoIdentityProvider = Service { _svcAbbrev = "CognitoIdentityProvider" , _svcSigner = v4 , _svcPrefix = "cognito-idp" , _svcVersion = "2016-04-18" , _svcEndpoint = defaultEndpoint cognitoIdentityProvider , _svcTimeout = Just 70 , _svcCheck = statusSuccess , _svcError = parseJSONError "CognitoIdentityProvider" , _svcRetry = retry } where retry = Exponential { _retryBase = 5.0e-2 , _retryGrowth = 2 , _retryAttempts = 5 , _retryCheck = check } check e | has (hasCode "ThrottledException" . hasStatus 400) e = Just "throttled_exception" | has (hasStatus 429) e = Just "too_many_requests" | has (hasCode "ThrottlingException" . hasStatus 400) e = Just "throttling_exception" | has (hasCode "Throttling" . hasStatus 400) e = Just "throttling" | has (hasStatus 504) e = Just "gateway_timeout" | has (hasStatus 502) e = Just "bad_gateway" | has (hasStatus 503) e = Just "service_unavailable" | has (hasStatus 500) e = Just "general_server_error" | has (hasStatus 509) e = Just "limit_exceeded" | otherwise = Nothing -- | The request failed because the user is in an unsupported state. -- -- _UnsupportedUserStateException :: AsError a => Getting (First ServiceError) a ServiceError _UnsupportedUserStateException = _MatchServiceError cognitoIdentityProvider "UnsupportedUserStateException" -- | This exception is thrown when a password reset is required. -- -- _PasswordResetRequiredException :: AsError a => Getting (First ServiceError) a ServiceError _PasswordResetRequiredException = _MatchServiceError cognitoIdentityProvider "PasswordResetRequiredException" -- | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. -- -- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidParameterException = _MatchServiceError cognitoIdentityProvider "InvalidParameterException" -- | This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response. -- -- _InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidLambdaResponseException = _MatchServiceError cognitoIdentityProvider "InvalidLambdaResponseException" -- | This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. -- -- _InvalidEmailRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidEmailRoleAccessPolicyException = _MatchServiceError cognitoIdentityProvider "InvalidEmailRoleAccessPolicyException" -- | This exception is thrown when the specified identifier is not supported. -- -- _UnsupportedIdentityProviderException :: AsError a => Getting (First ServiceError) a ServiceError _UnsupportedIdentityProviderException = _MatchServiceError cognitoIdentityProvider "UnsupportedIdentityProviderException" -- | This exception is thrown when a user is not found. -- -- _UserNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _UserNotFoundException = _MatchServiceError cognitoIdentityProvider "UserNotFoundException" -- | This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service. -- -- _UnexpectedLambdaException :: AsError a => Getting (First ServiceError) a ServiceError _UnexpectedLambdaException = _MatchServiceError cognitoIdentityProvider "UnexpectedLambdaException" -- | This exception is thrown when a user is not authorized. -- -- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError _NotAuthorizedException = _MatchServiceError cognitoIdentityProvider "NotAuthorizedException" -- | This exception is thrown when Amazon Cognito encounters an internal error. -- -- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError _InternalErrorException = _MatchServiceError cognitoIdentityProvider "InternalErrorException" -- | This exception is thrown when the user pool configuration is invalid. -- -- _InvalidUserPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidUserPoolConfigurationException = _MatchServiceError cognitoIdentityProvider "InvalidUserPoolConfigurationException" -- | This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS. -- -- _InvalidSmsRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidSmsRoleAccessPolicyException = _MatchServiceError cognitoIdentityProvider "InvalidSmsRoleAccessPolicyException" -- | This exception is thrown when the specified OAuth flow is invalid. -- -- _InvalidOAuthFlowException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidOAuthFlowException = _MatchServiceError cognitoIdentityProvider "InvalidOAuthFlowException" -- | This exception is thrown if the provided code does not match what the server was expecting. -- -- _CodeMismatchException :: AsError a => Getting (First ServiceError) a ServiceError _CodeMismatchException = _MatchServiceError cognitoIdentityProvider "CodeMismatchException" -- | This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool. -- -- _UserImportInProgressException :: AsError a => Getting (First ServiceError) a ServiceError _UserImportInProgressException = _MatchServiceError cognitoIdentityProvider "UserImportInProgressException" -- | 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. -- -- _InvalidSmsRoleTrustRelationshipException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidSmsRoleTrustRelationshipException = _MatchServiceError cognitoIdentityProvider "InvalidSmsRoleTrustRelationshipException" -- | This exception is thrown when a user pool tag cannot be set or updated. -- -- _UserPoolTaggingException :: AsError a => Getting (First ServiceError) a ServiceError _UserPoolTaggingException = _MatchServiceError cognitoIdentityProvider "UserPoolTaggingException" -- | This exception is thrown when the user has made too many requests for a given operation. -- -- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError _TooManyRequestsException = _MatchServiceError cognitoIdentityProvider "TooManyRequestsException" -- | This exception is thrown if two or more modifications are happening concurrently. -- -- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError _ConcurrentModificationException = _MatchServiceError cognitoIdentityProvider "ConcurrentModificationException" -- | This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service. -- -- _UserLambdaValidationException :: AsError a => Getting (First ServiceError) a ServiceError _UserLambdaValidationException = _MatchServiceError cognitoIdentityProvider "UserLambdaValidationException" -- | This exception is thrown when a precondition is not met. -- -- _PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError _PreconditionNotMetException = _MatchServiceError cognitoIdentityProvider "PreconditionNotMetException" -- | This exception is thrown if a code has expired. -- -- _ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError _ExpiredCodeException = _MatchServiceError cognitoIdentityProvider "ExpiredCodeException" -- | This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in). -- -- _TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError _TooManyFailedAttemptsException = _MatchServiceError cognitoIdentityProvider "TooManyFailedAttemptsException" -- | This exception is thrown when a user is not confirmed successfully. -- -- _UserNotConfirmedException :: AsError a => Getting (First ServiceError) a ServiceError _UserNotConfirmedException = _MatchServiceError cognitoIdentityProvider "UserNotConfirmedException" -- | This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool. -- -- _GroupExistsException :: AsError a => Getting (First ServiceError) a ServiceError _GroupExistsException = _MatchServiceError cognitoIdentityProvider "GroupExistsException" -- | This exception is thrown when a verification code fails to deliver successfully. -- -- _CodeDeliveryFailureException :: AsError a => Getting (First ServiceError) a ServiceError _CodeDeliveryFailureException = _MatchServiceError cognitoIdentityProvider "CodeDeliveryFailureException" -- | This exception is thrown when the specified scope does not exist. -- -- _ScopeDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError _ScopeDoesNotExistException = _MatchServiceError cognitoIdentityProvider "ScopeDoesNotExistException" -- | This exception is thrown when the Amazon Cognito service cannot find the requested resource. -- -- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceNotFoundException = _MatchServiceError cognitoIdentityProvider "ResourceNotFoundException" -- | This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method. -- -- _MFAMethodNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _MFAMethodNotFoundException = _MatchServiceError cognitoIdentityProvider "MFAMethodNotFoundException" -- | 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. -- -- _AliasExistsException :: AsError a => Getting (First ServiceError) a ServiceError _AliasExistsException = _MatchServiceError cognitoIdentityProvider "AliasExistsException" -- | This exception is thrown when the provider is already supported by the user pool. -- -- _DuplicateProviderException :: AsError a => Getting (First ServiceError) a ServiceError _DuplicateProviderException = _MatchServiceError cognitoIdentityProvider "DuplicateProviderException" -- | This exception is thrown when a user exceeds the limit for a requested AWS resource. -- -- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _LimitExceededException = _MatchServiceError cognitoIdentityProvider "LimitExceededException" -- | This exception is thrown when the Amazon Cognito service encounters an invalid password. -- -- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidPasswordException = _MatchServiceError cognitoIdentityProvider "InvalidPasswordException" -- | This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool. -- -- _UsernameExistsException :: AsError a => Getting (First ServiceError) a ServiceError _UsernameExistsException = _MatchServiceError cognitoIdentityProvider "UsernameExistsException"