| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CognitoIdentityProvider.Types
Contents
- Service Configuration
- Errors
- AccountTakeoverEventActionType
- AdvancedSecurityModeType
- AliasAttributeType
- AttributeDataType
- AuthFlowType
- ChallengeName
- ChallengeNameType
- ChallengeResponse
- CompromisedCredentialsEventActionType
- DefaultEmailOptionType
- DeliveryMediumType
- DeviceRememberedStatusType
- DomainStatusType
- EventFilterType
- EventResponseType
- EventType
- ExplicitAuthFlowsType
- FeedbackValueType
- IdentityProviderTypeType
- MessageActionType
- OAuthFlowType
- RiskDecisionType
- RiskLevelType
- StatusType
- UserImportJobStatusType
- UserPoolMFAType
- UserStatusType
- UsernameAttributeType
- VerifiedAttributeType
- VerifySoftwareTokenResponseType
- AccountTakeoverActionType
- AccountTakeoverActionsType
- AccountTakeoverRiskConfigurationType
- AdminCreateUserConfigType
- AnalyticsConfigurationType
- AnalyticsMetadataType
- AttributeType
- AuthEventType
- AuthenticationResultType
- ChallengeResponseType
- CodeDeliveryDetailsType
- CompromisedCredentialsActionsType
- CompromisedCredentialsRiskConfigurationType
- ContextDataType
- DeviceConfigurationType
- DeviceSecretVerifierConfigType
- DeviceType
- DomainDescriptionType
- EmailConfigurationType
- EventContextDataType
- EventFeedbackType
- EventRiskType
- GroupType
- HTTPHeader
- IdentityProviderType
- LambdaConfigType
- MFAOptionType
- MessageTemplateType
- NewDeviceMetadataType
- NotifyConfigurationType
- NotifyEmailType
- NumberAttributeConstraintsType
- PasswordPolicyType
- ProviderDescription
- ProviderUserIdentifierType
- ResourceServerScopeType
- ResourceServerType
- RiskConfigurationType
- RiskExceptionConfigurationType
- SMSMFASettingsType
- SchemaAttributeType
- SmsConfigurationType
- SmsMFAConfigType
- SoftwareTokenMFAConfigType
- SoftwareTokenMFASettingsType
- StringAttributeConstraintsType
- UICustomizationType
- UserContextDataType
- UserImportJobType
- UserPoolAddOnsType
- UserPoolClientDescription
- UserPoolClientType
- UserPoolDescriptionType
- UserPoolPolicyType
- UserPoolType
- UserType
- VerificationMessageTemplateType
Description
Synopsis
- cognitoIdentityProvider :: Service
- _UnsupportedUserStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _PasswordResetRequiredException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEmailRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedIdentityProviderException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnexpectedLambdaException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidUserPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSmsRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOAuthFlowException :: AsError a => Getting (First ServiceError) a ServiceError
- _CodeMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserImportInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSmsRoleTrustRelationshipException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserPoolTaggingException :: AsError a => Getting (First ServiceError) a ServiceError
- _SoftwareTokenMFANotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserPoolAddOnNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserLambdaValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError
- _EnableSoftwareTokenMFAException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserNotConfirmedException :: AsError a => Getting (First ServiceError) a ServiceError
- _GroupExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CodeDeliveryFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _ScopeDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _MFAMethodNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _AliasExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateProviderException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError
- _UsernameExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- data AccountTakeoverEventActionType
- data AdvancedSecurityModeType
- data AliasAttributeType
- data AttributeDataType
- data AuthFlowType
- data ChallengeName
- data ChallengeNameType
- data ChallengeResponse
- data CompromisedCredentialsEventActionType
- data DefaultEmailOptionType
- data DeliveryMediumType
- data DeviceRememberedStatusType
- data DomainStatusType
- data EventFilterType
- data EventResponseType
- data EventType
- data ExplicitAuthFlowsType
- data FeedbackValueType
- data IdentityProviderTypeType
- data MessageActionType
- data OAuthFlowType
- data RiskDecisionType
- data RiskLevelType
- data StatusType
- data UserImportJobStatusType
- data UserPoolMFAType
- data UserStatusType
- data UsernameAttributeType
- data VerifiedAttributeType
- | PhoneNumber
- data VerifySoftwareTokenResponseType
- data AccountTakeoverActionType
- accountTakeoverActionType :: Bool -> AccountTakeoverEventActionType -> AccountTakeoverActionType
- atatNotify :: Lens' AccountTakeoverActionType Bool
- atatEventAction :: Lens' AccountTakeoverActionType AccountTakeoverEventActionType
- data AccountTakeoverActionsType
- accountTakeoverActionsType :: AccountTakeoverActionsType
- atatLowAction :: Lens' AccountTakeoverActionsType (Maybe AccountTakeoverActionType)
- atatHighAction :: Lens' AccountTakeoverActionsType (Maybe AccountTakeoverActionType)
- atatMediumAction :: Lens' AccountTakeoverActionsType (Maybe AccountTakeoverActionType)
- data AccountTakeoverRiskConfigurationType
- accountTakeoverRiskConfigurationType :: AccountTakeoverActionsType -> AccountTakeoverRiskConfigurationType
- atrctNotifyConfiguration :: Lens' AccountTakeoverRiskConfigurationType (Maybe NotifyConfigurationType)
- atrctActions :: Lens' AccountTakeoverRiskConfigurationType AccountTakeoverActionsType
- data AdminCreateUserConfigType
- adminCreateUserConfigType :: AdminCreateUserConfigType
- acuctAllowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool)
- acuctUnusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural)
- acuctInviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType)
- data AnalyticsConfigurationType
- analyticsConfigurationType :: Text -> Text -> Text -> AnalyticsConfigurationType
- actUserDataShared :: Lens' AnalyticsConfigurationType (Maybe Bool)
- actApplicationId :: Lens' AnalyticsConfigurationType Text
- actRoleARN :: Lens' AnalyticsConfigurationType Text
- actExternalId :: Lens' AnalyticsConfigurationType Text
- data AnalyticsMetadataType
- analyticsMetadataType :: AnalyticsMetadataType
- amtAnalyticsEndpointId :: Lens' AnalyticsMetadataType (Maybe Text)
- data AttributeType
- attributeType :: Text -> AttributeType
- atValue :: Lens' AttributeType (Maybe Text)
- atName :: Lens' AttributeType Text
- data AuthEventType
- authEventType :: AuthEventType
- aetEventRisk :: Lens' AuthEventType (Maybe EventRiskType)
- aetEventResponse :: Lens' AuthEventType (Maybe EventResponseType)
- aetEventContextData :: Lens' AuthEventType (Maybe EventContextDataType)
- aetChallengeResponses :: Lens' AuthEventType [ChallengeResponseType]
- aetEventType :: Lens' AuthEventType (Maybe EventType)
- aetCreationDate :: Lens' AuthEventType (Maybe UTCTime)
- aetEventFeedback :: Lens' AuthEventType (Maybe EventFeedbackType)
- aetEventId :: Lens' AuthEventType (Maybe Text)
- data AuthenticationResultType
- authenticationResultType :: AuthenticationResultType
- artAccessToken :: Lens' AuthenticationResultType (Maybe Text)
- artRefreshToken :: Lens' AuthenticationResultType (Maybe Text)
- artNewDeviceMetadata :: Lens' AuthenticationResultType (Maybe NewDeviceMetadataType)
- artExpiresIn :: Lens' AuthenticationResultType (Maybe Int)
- artTokenType :: Lens' AuthenticationResultType (Maybe Text)
- artIdToken :: Lens' AuthenticationResultType (Maybe Text)
- data ChallengeResponseType
- challengeResponseType :: ChallengeResponseType
- crtChallengeName :: Lens' ChallengeResponseType (Maybe ChallengeName)
- crtChallengeResponse :: Lens' ChallengeResponseType (Maybe ChallengeResponse)
- data CodeDeliveryDetailsType
- codeDeliveryDetailsType :: CodeDeliveryDetailsType
- cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text)
- cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType)
- cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text)
- data CompromisedCredentialsActionsType
- compromisedCredentialsActionsType :: CompromisedCredentialsEventActionType -> CompromisedCredentialsActionsType
- ccatEventAction :: Lens' CompromisedCredentialsActionsType CompromisedCredentialsEventActionType
- data CompromisedCredentialsRiskConfigurationType
- compromisedCredentialsRiskConfigurationType :: CompromisedCredentialsActionsType -> CompromisedCredentialsRiskConfigurationType
- ccrctEventFilter :: Lens' CompromisedCredentialsRiskConfigurationType [EventFilterType]
- ccrctActions :: Lens' CompromisedCredentialsRiskConfigurationType CompromisedCredentialsActionsType
- data ContextDataType
- contextDataType :: Text -> Text -> Text -> ContextDataType
- cdtEncodedData :: Lens' ContextDataType (Maybe Text)
- cdtIPAddress :: Lens' ContextDataType Text
- cdtServerName :: Lens' ContextDataType Text
- cdtServerPath :: Lens' ContextDataType Text
- cdtHTTPHeaders :: Lens' ContextDataType [HTTPHeader]
- data DeviceConfigurationType
- deviceConfigurationType :: DeviceConfigurationType
- dctChallengeRequiredOnNewDevice :: Lens' DeviceConfigurationType (Maybe Bool)
- dctDeviceOnlyRememberedOnUserPrompt :: Lens' DeviceConfigurationType (Maybe Bool)
- data DeviceSecretVerifierConfigType
- deviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType
- dsvctPasswordVerifier :: Lens' DeviceSecretVerifierConfigType (Maybe Text)
- dsvctSalt :: Lens' DeviceSecretVerifierConfigType (Maybe Text)
- data DeviceType
- deviceType :: DeviceType
- dtDeviceLastModifiedDate :: Lens' DeviceType (Maybe UTCTime)
- dtDeviceCreateDate :: Lens' DeviceType (Maybe UTCTime)
- dtDeviceAttributes :: Lens' DeviceType [AttributeType]
- dtDeviceKey :: Lens' DeviceType (Maybe Text)
- dtDeviceLastAuthenticatedDate :: Lens' DeviceType (Maybe UTCTime)
- data DomainDescriptionType
- domainDescriptionType :: DomainDescriptionType
- ddtStatus :: Lens' DomainDescriptionType (Maybe DomainStatusType)
- ddtCloudFrontDistribution :: Lens' DomainDescriptionType (Maybe Text)
- ddtUserPoolId :: Lens' DomainDescriptionType (Maybe Text)
- ddtDomain :: Lens' DomainDescriptionType (Maybe Text)
- ddtAWSAccountId :: Lens' DomainDescriptionType (Maybe Text)
- ddtVersion :: Lens' DomainDescriptionType (Maybe Text)
- ddtS3Bucket :: Lens' DomainDescriptionType (Maybe Text)
- data EmailConfigurationType
- emailConfigurationType :: EmailConfigurationType
- ectSourceARN :: Lens' EmailConfigurationType (Maybe Text)
- ectReplyToEmailAddress :: Lens' EmailConfigurationType (Maybe Text)
- data EventContextDataType
- eventContextDataType :: EventContextDataType
- ecdtIPAddress :: Lens' EventContextDataType (Maybe Text)
- ecdtCountry :: Lens' EventContextDataType (Maybe Text)
- ecdtCity :: Lens' EventContextDataType (Maybe Text)
- ecdtDeviceName :: Lens' EventContextDataType (Maybe Text)
- ecdtTimezone :: Lens' EventContextDataType (Maybe Text)
- data EventFeedbackType
- eventFeedbackType :: FeedbackValueType -> Text -> EventFeedbackType
- eftFeedbackDate :: Lens' EventFeedbackType (Maybe UTCTime)
- eftFeedbackValue :: Lens' EventFeedbackType FeedbackValueType
- eftProvider :: Lens' EventFeedbackType Text
- data EventRiskType
- eventRiskType :: EventRiskType
- ertRiskLevel :: Lens' EventRiskType (Maybe RiskLevelType)
- ertRiskDecision :: Lens' EventRiskType (Maybe RiskDecisionType)
- data GroupType
- groupType :: GroupType
- gtLastModifiedDate :: Lens' GroupType (Maybe UTCTime)
- gtUserPoolId :: Lens' GroupType (Maybe Text)
- gtCreationDate :: Lens' GroupType (Maybe UTCTime)
- gtPrecedence :: Lens' GroupType (Maybe Natural)
- gtGroupName :: Lens' GroupType (Maybe Text)
- gtDescription :: Lens' GroupType (Maybe Text)
- gtRoleARN :: Lens' GroupType (Maybe Text)
- data HTTPHeader
- hTTPHeader :: HTTPHeader
- httphHeaderValue :: Lens' HTTPHeader (Maybe Text)
- httphHeaderName :: Lens' HTTPHeader (Maybe Text)
- data IdentityProviderType
- identityProviderType :: IdentityProviderType
- iptLastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime)
- iptUserPoolId :: Lens' IdentityProviderType (Maybe Text)
- iptProviderType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType)
- iptCreationDate :: Lens' IdentityProviderType (Maybe UTCTime)
- iptIdpIdentifiers :: Lens' IdentityProviderType [Text]
- iptAttributeMapping :: Lens' IdentityProviderType (HashMap Text Text)
- iptProviderDetails :: Lens' IdentityProviderType (HashMap Text Text)
- iptProviderName :: Lens' IdentityProviderType (Maybe Text)
- data LambdaConfigType
- lambdaConfigType :: LambdaConfigType
- lctPreAuthentication :: Lens' LambdaConfigType (Maybe Text)
- lctCreateAuthChallenge :: Lens' LambdaConfigType (Maybe Text)
- lctVerifyAuthChallengeResponse :: Lens' LambdaConfigType (Maybe Text)
- lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text)
- lctCustomMessage :: Lens' LambdaConfigType (Maybe Text)
- lctDefineAuthChallenge :: Lens' LambdaConfigType (Maybe Text)
- lctPostConfirmation :: Lens' LambdaConfigType (Maybe Text)
- lctPreTokenGeneration :: Lens' LambdaConfigType (Maybe Text)
- lctUserMigration :: Lens' LambdaConfigType (Maybe Text)
- lctPreSignUp :: Lens' LambdaConfigType (Maybe Text)
- data MFAOptionType
- mfaOptionType :: MFAOptionType
- motDeliveryMedium :: Lens' MFAOptionType (Maybe DeliveryMediumType)
- motAttributeName :: Lens' MFAOptionType (Maybe Text)
- data MessageTemplateType
- messageTemplateType :: MessageTemplateType
- mttEmailSubject :: Lens' MessageTemplateType (Maybe Text)
- mttSMSMessage :: Lens' MessageTemplateType (Maybe Text)
- mttEmailMessage :: Lens' MessageTemplateType (Maybe Text)
- data NewDeviceMetadataType
- newDeviceMetadataType :: NewDeviceMetadataType
- ndmtDeviceGroupKey :: Lens' NewDeviceMetadataType (Maybe Text)
- ndmtDeviceKey :: Lens' NewDeviceMetadataType (Maybe Text)
- data NotifyConfigurationType
- notifyConfigurationType :: Text -> NotifyConfigurationType
- nctNoActionEmail :: Lens' NotifyConfigurationType (Maybe NotifyEmailType)
- nctFrom :: Lens' NotifyConfigurationType (Maybe Text)
- nctReplyTo :: Lens' NotifyConfigurationType (Maybe Text)
- nctBlockEmail :: Lens' NotifyConfigurationType (Maybe NotifyEmailType)
- nctMFAEmail :: Lens' NotifyConfigurationType (Maybe NotifyEmailType)
- nctSourceARN :: Lens' NotifyConfigurationType Text
- data NotifyEmailType
- notifyEmailType :: Text -> NotifyEmailType
- netTextBody :: Lens' NotifyEmailType (Maybe Text)
- netHTMLBody :: Lens' NotifyEmailType (Maybe Text)
- netSubject :: Lens' NotifyEmailType Text
- data NumberAttributeConstraintsType
- numberAttributeConstraintsType :: NumberAttributeConstraintsType
- nactMaxValue :: Lens' NumberAttributeConstraintsType (Maybe Text)
- nactMinValue :: Lens' NumberAttributeConstraintsType (Maybe Text)
- data PasswordPolicyType
- passwordPolicyType :: PasswordPolicyType
- pptRequireNumbers :: Lens' PasswordPolicyType (Maybe Bool)
- pptRequireUppercase :: Lens' PasswordPolicyType (Maybe Bool)
- pptRequireLowercase :: Lens' PasswordPolicyType (Maybe Bool)
- pptMinimumLength :: Lens' PasswordPolicyType (Maybe Natural)
- pptRequireSymbols :: Lens' PasswordPolicyType (Maybe Bool)
- data ProviderDescription
- providerDescription :: ProviderDescription
- pdLastModifiedDate :: Lens' ProviderDescription (Maybe UTCTime)
- pdProviderType :: Lens' ProviderDescription (Maybe IdentityProviderTypeType)
- pdCreationDate :: Lens' ProviderDescription (Maybe UTCTime)
- pdProviderName :: Lens' ProviderDescription (Maybe Text)
- data ProviderUserIdentifierType
- providerUserIdentifierType :: ProviderUserIdentifierType
- puitProviderAttributeValue :: Lens' ProviderUserIdentifierType (Maybe Text)
- puitProviderAttributeName :: Lens' ProviderUserIdentifierType (Maybe Text)
- puitProviderName :: Lens' ProviderUserIdentifierType (Maybe Text)
- data ResourceServerScopeType
- resourceServerScopeType :: Text -> Text -> ResourceServerScopeType
- rsstScopeName :: Lens' ResourceServerScopeType Text
- rsstScopeDescription :: Lens' ResourceServerScopeType Text
- data ResourceServerType
- resourceServerType :: ResourceServerType
- rstUserPoolId :: Lens' ResourceServerType (Maybe Text)
- rstIdentifier :: Lens' ResourceServerType (Maybe Text)
- rstScopes :: Lens' ResourceServerType [ResourceServerScopeType]
- rstName :: Lens' ResourceServerType (Maybe Text)
- data RiskConfigurationType
- riskConfigurationType :: RiskConfigurationType
- rctRiskExceptionConfiguration :: Lens' RiskConfigurationType (Maybe RiskExceptionConfigurationType)
- rctClientId :: Lens' RiskConfigurationType (Maybe Text)
- rctAccountTakeoverRiskConfiguration :: Lens' RiskConfigurationType (Maybe AccountTakeoverRiskConfigurationType)
- rctLastModifiedDate :: Lens' RiskConfigurationType (Maybe UTCTime)
- rctUserPoolId :: Lens' RiskConfigurationType (Maybe Text)
- rctCompromisedCredentialsRiskConfiguration :: Lens' RiskConfigurationType (Maybe CompromisedCredentialsRiskConfigurationType)
- data RiskExceptionConfigurationType
- riskExceptionConfigurationType :: RiskExceptionConfigurationType
- rectSkippedIPRangeList :: Lens' RiskExceptionConfigurationType [Text]
- rectBlockedIPRangeList :: Lens' RiskExceptionConfigurationType [Text]
- data SMSMFASettingsType
- sMSMFASettingsType :: SMSMFASettingsType
- smsmstEnabled :: Lens' SMSMFASettingsType (Maybe Bool)
- smsmstPreferredMFA :: Lens' SMSMFASettingsType (Maybe Bool)
- data SchemaAttributeType
- schemaAttributeType :: SchemaAttributeType
- satNumberAttributeConstraints :: Lens' SchemaAttributeType (Maybe NumberAttributeConstraintsType)
- satRequired :: Lens' SchemaAttributeType (Maybe Bool)
- satAttributeDataType :: Lens' SchemaAttributeType (Maybe AttributeDataType)
- satStringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType)
- satName :: Lens' SchemaAttributeType (Maybe Text)
- satDeveloperOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool)
- satMutable :: Lens' SchemaAttributeType (Maybe Bool)
- data SmsConfigurationType
- smsConfigurationType :: Text -> SmsConfigurationType
- sctExternalId :: Lens' SmsConfigurationType (Maybe Text)
- sctSNSCallerARN :: Lens' SmsConfigurationType Text
- data SmsMFAConfigType
- smsMFAConfigType :: SmsMFAConfigType
- smctSmsAuthenticationMessage :: Lens' SmsMFAConfigType (Maybe Text)
- smctSmsConfiguration :: Lens' SmsMFAConfigType (Maybe SmsConfigurationType)
- data SoftwareTokenMFAConfigType
- softwareTokenMFAConfigType :: SoftwareTokenMFAConfigType
- stmctEnabled :: Lens' SoftwareTokenMFAConfigType (Maybe Bool)
- data SoftwareTokenMFASettingsType
- softwareTokenMFASettingsType :: SoftwareTokenMFASettingsType
- stmstEnabled :: Lens' SoftwareTokenMFASettingsType (Maybe Bool)
- stmstPreferredMFA :: Lens' SoftwareTokenMFASettingsType (Maybe Bool)
- data StringAttributeConstraintsType
- stringAttributeConstraintsType :: StringAttributeConstraintsType
- sactMaxLength :: Lens' StringAttributeConstraintsType (Maybe Text)
- sactMinLength :: Lens' StringAttributeConstraintsType (Maybe Text)
- data UICustomizationType
- uICustomizationType :: UICustomizationType
- uictClientId :: Lens' UICustomizationType (Maybe Text)
- uictLastModifiedDate :: Lens' UICustomizationType (Maybe UTCTime)
- uictUserPoolId :: Lens' UICustomizationType (Maybe Text)
- uictCSS :: Lens' UICustomizationType (Maybe Text)
- uictCSSVersion :: Lens' UICustomizationType (Maybe Text)
- uictImageURL :: Lens' UICustomizationType (Maybe Text)
- uictCreationDate :: Lens' UICustomizationType (Maybe UTCTime)
- data UserContextDataType
- userContextDataType :: UserContextDataType
- ucdtEncodedData :: Lens' UserContextDataType (Maybe Text)
- data UserImportJobType
- userImportJobType :: UserImportJobType
- uijtStatus :: Lens' UserImportJobType (Maybe UserImportJobStatusType)
- uijtSkippedUsers :: Lens' UserImportJobType (Maybe Integer)
- uijtJobId :: Lens' UserImportJobType (Maybe Text)
- uijtUserPoolId :: Lens' UserImportJobType (Maybe Text)
- uijtJobName :: Lens' UserImportJobType (Maybe Text)
- uijtPreSignedURL :: Lens' UserImportJobType (Maybe Text)
- uijtFailedUsers :: Lens' UserImportJobType (Maybe Integer)
- uijtStartDate :: Lens' UserImportJobType (Maybe UTCTime)
- uijtCompletionMessage :: Lens' UserImportJobType (Maybe Text)
- uijtCreationDate :: Lens' UserImportJobType (Maybe UTCTime)
- uijtCompletionDate :: Lens' UserImportJobType (Maybe UTCTime)
- uijtCloudWatchLogsRoleARN :: Lens' UserImportJobType (Maybe Text)
- uijtImportedUsers :: Lens' UserImportJobType (Maybe Integer)
- data UserPoolAddOnsType
- userPoolAddOnsType :: AdvancedSecurityModeType -> UserPoolAddOnsType
- upaotAdvancedSecurityMode :: Lens' UserPoolAddOnsType AdvancedSecurityModeType
- data UserPoolClientDescription
- userPoolClientDescription :: UserPoolClientDescription
- upcdClientId :: Lens' UserPoolClientDescription (Maybe Text)
- upcdUserPoolId :: Lens' UserPoolClientDescription (Maybe Text)
- upcdClientName :: Lens' UserPoolClientDescription (Maybe Text)
- data UserPoolClientType
- userPoolClientType :: UserPoolClientType
- upctRefreshTokenValidity :: Lens' UserPoolClientType (Maybe Natural)
- upctClientId :: Lens' UserPoolClientType (Maybe Text)
- upctExplicitAuthFlows :: Lens' UserPoolClientType [ExplicitAuthFlowsType]
- upctClientSecret :: Lens' UserPoolClientType (Maybe Text)
- upctLastModifiedDate :: Lens' UserPoolClientType (Maybe UTCTime)
- upctSupportedIdentityProviders :: Lens' UserPoolClientType [Text]
- upctLogoutURLs :: Lens' UserPoolClientType [Text]
- upctAllowedOAuthFlowsUserPoolClient :: Lens' UserPoolClientType (Maybe Bool)
- upctUserPoolId :: Lens' UserPoolClientType (Maybe Text)
- upctDefaultRedirectURI :: Lens' UserPoolClientType (Maybe Text)
- upctWriteAttributes :: Lens' UserPoolClientType [Text]
- upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime)
- upctReadAttributes :: Lens' UserPoolClientType [Text]
- upctAllowedOAuthScopes :: Lens' UserPoolClientType [Text]
- upctAllowedOAuthFlows :: Lens' UserPoolClientType [OAuthFlowType]
- upctAnalyticsConfiguration :: Lens' UserPoolClientType (Maybe AnalyticsConfigurationType)
- upctClientName :: Lens' UserPoolClientType (Maybe Text)
- upctCallbackURLs :: Lens' UserPoolClientType [Text]
- data UserPoolDescriptionType
- userPoolDescriptionType :: UserPoolDescriptionType
- updtStatus :: Lens' UserPoolDescriptionType (Maybe StatusType)
- updtLastModifiedDate :: Lens' UserPoolDescriptionType (Maybe UTCTime)
- updtName :: Lens' UserPoolDescriptionType (Maybe Text)
- updtId :: Lens' UserPoolDescriptionType (Maybe Text)
- updtCreationDate :: Lens' UserPoolDescriptionType (Maybe UTCTime)
- updtLambdaConfig :: Lens' UserPoolDescriptionType (Maybe LambdaConfigType)
- data UserPoolPolicyType
- userPoolPolicyType :: UserPoolPolicyType
- upptPasswordPolicy :: Lens' UserPoolPolicyType (Maybe PasswordPolicyType)
- data UserPoolType
- userPoolType :: UserPoolType
- uptStatus :: Lens' UserPoolType (Maybe StatusType)
- uptUserPoolTags :: Lens' UserPoolType (HashMap Text Text)
- uptEmailConfigurationFailure :: Lens' UserPoolType (Maybe Text)
- uptLastModifiedDate :: Lens' UserPoolType (Maybe UTCTime)
- uptVerificationMessageTemplate :: Lens' UserPoolType (Maybe VerificationMessageTemplateType)
- uptEstimatedNumberOfUsers :: Lens' UserPoolType (Maybe Int)
- uptDomain :: Lens' UserPoolType (Maybe Text)
- uptEmailVerificationMessage :: Lens' UserPoolType (Maybe Text)
- uptSmsAuthenticationMessage :: Lens' UserPoolType (Maybe Text)
- uptUserPoolAddOns :: Lens' UserPoolType (Maybe UserPoolAddOnsType)
- uptSchemaAttributes :: Lens' UserPoolType (Maybe (NonEmpty SchemaAttributeType))
- uptEmailVerificationSubject :: Lens' UserPoolType (Maybe Text)
- uptUsernameAttributes :: Lens' UserPoolType [UsernameAttributeType]
- uptAliasAttributes :: Lens' UserPoolType [AliasAttributeType]
- uptEmailConfiguration :: Lens' UserPoolType (Maybe EmailConfigurationType)
- uptSmsVerificationMessage :: Lens' UserPoolType (Maybe Text)
- uptName :: Lens' UserPoolType (Maybe Text)
- uptMFAConfiguration :: Lens' UserPoolType (Maybe UserPoolMFAType)
- uptId :: Lens' UserPoolType (Maybe Text)
- uptSmsConfigurationFailure :: Lens' UserPoolType (Maybe Text)
- uptCreationDate :: Lens' UserPoolType (Maybe UTCTime)
- uptLambdaConfig :: Lens' UserPoolType (Maybe LambdaConfigType)
- uptSmsConfiguration :: Lens' UserPoolType (Maybe SmsConfigurationType)
- uptAdminCreateUserConfig :: Lens' UserPoolType (Maybe AdminCreateUserConfigType)
- uptDeviceConfiguration :: Lens' UserPoolType (Maybe DeviceConfigurationType)
- uptAutoVerifiedAttributes :: Lens' UserPoolType [VerifiedAttributeType]
- uptPolicies :: Lens' UserPoolType (Maybe UserPoolPolicyType)
- data UserType
- userType :: UserType
- utEnabled :: Lens' UserType (Maybe Bool)
- utUserStatus :: Lens' UserType (Maybe UserStatusType)
- utUsername :: Lens' UserType (Maybe Text)
- utUserCreateDate :: Lens' UserType (Maybe UTCTime)
- utAttributes :: Lens' UserType [AttributeType]
- utMFAOptions :: Lens' UserType [MFAOptionType]
- utUserLastModifiedDate :: Lens' UserType (Maybe UTCTime)
- data VerificationMessageTemplateType
- verificationMessageTemplateType :: VerificationMessageTemplateType
- vmttDefaultEmailOption :: Lens' VerificationMessageTemplateType (Maybe DefaultEmailOptionType)
- vmttEmailSubject :: Lens' VerificationMessageTemplateType (Maybe Text)
- vmttEmailSubjectByLink :: Lens' VerificationMessageTemplateType (Maybe Text)
- vmttSmsMessage :: Lens' VerificationMessageTemplateType (Maybe Text)
- vmttEmailMessageByLink :: Lens' VerificationMessageTemplateType (Maybe Text)
- vmttEmailMessage :: Lens' VerificationMessageTemplateType (Maybe Text)
Service Configuration
cognitoIdentityProvider :: Service #
API version 2016-04-18 of the Amazon Cognito Identity Provider SDK configuration.
Errors
_UnsupportedUserStateException :: AsError a => Getting (First ServiceError) a ServiceError #
The request failed because the user is in an unsupported state.
_PasswordResetRequiredException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a password reset is required.
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
_InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
_InvalidEmailRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
_UnsupportedIdentityProviderException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the specified identifier is not supported.
_UserNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a user is not found.
_UnexpectedLambdaException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a user is not authorized.
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when Amazon Cognito encounters an internal error.
_InvalidUserPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the user pool configuration is invalid.
_InvalidSmsRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
_InvalidOAuthFlowException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the specified OAuth flow is invalid.
_CodeMismatchException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown if the provided code does not match what the server was expecting.
_UserImportInProgressException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.
_InvalidSmsRoleTrustRelationshipException :: AsError a => Getting (First ServiceError) a ServiceError #
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.
_UserPoolTaggingException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a user pool tag cannot be set or updated.
_SoftwareTokenMFANotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled for the user pool.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the user has made too many requests for a given operation.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown if two or more modifications are happening concurrently.
_UserPoolAddOnNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when user pool add-ons are not enabled.
_UserLambdaValidationException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
_PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a precondition is not met.
_ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown if a code has expired.
_TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).
_EnableSoftwareTokenMFAException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
_UserNotConfirmedException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a user is not confirmed successfully.
_GroupExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
_CodeDeliveryFailureException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a verification code fails to deliver successfully.
_ScopeDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the specified scope does not exist.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
_MFAMethodNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.
_AliasExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
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.
_DuplicateProviderException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the provider is already supported by the user pool.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when a user exceeds the limit for a requested AWS resource.
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when the Amazon Cognito service encounters an invalid password.
_UsernameExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
AccountTakeoverEventActionType
data AccountTakeoverEventActionType #
Constructors
| ATEATBlock | |
| ATEATMFAIfConfigured | |
| ATEATMFARequired | |
| ATEATNoAction |
Instances
AdvancedSecurityModeType
data AdvancedSecurityModeType #
Instances
AliasAttributeType
data AliasAttributeType #
Constructors
| AATEmail | |
| AATPhoneNumber | |
| AATPreferredUsername |
Instances
AttributeDataType
data AttributeDataType #
Instances
AuthFlowType
data AuthFlowType #
Instances
ChallengeName
data ChallengeName #
Instances
ChallengeNameType
data ChallengeNameType #
Constructors
| CNTAdminNoSrpAuth | |
| CNTCustomChallenge | |
| CNTDevicePasswordVerifier | |
| CNTDeviceSrpAuth | |
| CNTMFASetup | |
| CNTNewPasswordRequired | |
| CNTPasswordVerifier | |
| CNTSelectMFAType | |
| CNTSmsMFA | |
| CNTSoftwareTokenMFA |
Instances
ChallengeResponse
data ChallengeResponse #
Instances
CompromisedCredentialsEventActionType
data CompromisedCredentialsEventActionType #
Constructors
| CCEATBlock | |
| CCEATNoAction |
Instances
DefaultEmailOptionType
data DefaultEmailOptionType #
Constructors
| ConfirmWithCode | |
| ConfirmWithLink |
Instances
DeliveryMediumType
data DeliveryMediumType #
Instances
DeviceRememberedStatusType
data DeviceRememberedStatusType #
Constructors
| NotRemembered | |
| Remembered |
Instances
DomainStatusType
data DomainStatusType #
Constructors
| DSTActive | |
| DSTCreating | |
| DSTDeleting | |
| DSTFailed | |
| DSTUpdating |
Instances
EventFilterType
data EventFilterType #
Constructors
| PasswordChange | |
| SignIn | |
| SignUp |
Instances
EventResponseType
data EventResponseType #
Instances
EventType
Constructors
| ETForgotPassword | |
| ETSignIn | |
| ETSignUp |
Instances
ExplicitAuthFlowsType
data ExplicitAuthFlowsType #
Instances
FeedbackValueType
data FeedbackValueType #
Instances
IdentityProviderTypeType
data IdentityProviderTypeType #
Constructors
| LoginWithAmazon | |
| Saml |
Instances
MessageActionType
data MessageActionType #
Instances
OAuthFlowType
data OAuthFlowType #
Constructors
| ClientCredentials | |
| Code | |
| Implicit |
Instances
RiskDecisionType
data RiskDecisionType #
Constructors
| AccountTakeover | |
| Block | |
| NoRisk |
Instances
RiskLevelType
data RiskLevelType #
Instances
StatusType
data StatusType #
Instances
UserImportJobStatusType
data UserImportJobStatusType #
Instances
UserPoolMFAType
data UserPoolMFAType #
Constructors
| UPMTON | |
| UPMTOff | |
| UPMTOptional |
Instances
UserStatusType
data UserStatusType #
Instances
UsernameAttributeType
data UsernameAttributeType #
Constructors
| UATEmail | |
| UATPhoneNumber |
Instances
VerifiedAttributeType
data VerifiedAttributeType #
Constructors
| PhoneNumber |
Instances
VerifySoftwareTokenResponseType
data VerifySoftwareTokenResponseType #
Constructors
| VSTRTError' | |
| VSTRTSuccess |
Instances
AccountTakeoverActionType
data AccountTakeoverActionType #
Account takeover action type.
See: accountTakeoverActionType smart constructor.
Instances
Arguments
| :: Bool | |
| -> AccountTakeoverEventActionType | |
| -> AccountTakeoverActionType |
Creates a value of AccountTakeoverActionType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atatNotify- Flag specifying whether to send a notification.atatEventAction- The event action. *BLOCKChoosing this action will block the request. *MFA_IF_CONFIGUREDThrow MFA challenge if user has configured it, else allow the request. *MFA_REQUIREDThrow MFA challenge if user has configured it, else block the request. *NO_ACTIONAllow the user sign-in.
atatNotify :: Lens' AccountTakeoverActionType Bool #
Flag specifying whether to send a notification.
atatEventAction :: Lens' AccountTakeoverActionType AccountTakeoverEventActionType #
The event action. * BLOCK Choosing this action will block the request. * MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request. * MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request. * NO_ACTION Allow the user sign-in.
AccountTakeoverActionsType
data AccountTakeoverActionsType #
Account takeover actions type.
See: accountTakeoverActionsType smart constructor.
Instances
accountTakeoverActionsType :: AccountTakeoverActionsType #
Creates a value of AccountTakeoverActionsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atatLowAction- Action to take for a low risk.atatHighAction- Action to take for a high risk.atatMediumAction- Action to take for a medium risk.
atatLowAction :: Lens' AccountTakeoverActionsType (Maybe AccountTakeoverActionType) #
Action to take for a low risk.
atatHighAction :: Lens' AccountTakeoverActionsType (Maybe AccountTakeoverActionType) #
Action to take for a high risk.
atatMediumAction :: Lens' AccountTakeoverActionsType (Maybe AccountTakeoverActionType) #
Action to take for a medium risk.
AccountTakeoverRiskConfigurationType
data AccountTakeoverRiskConfigurationType #
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
See: accountTakeoverRiskConfigurationType smart constructor.
Instances
accountTakeoverRiskConfigurationType #
Creates a value of AccountTakeoverRiskConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atrctNotifyConfiguration- The notify configuration used to construct email notifications.atrctActions- Account takeover risk configuration actions
atrctNotifyConfiguration :: Lens' AccountTakeoverRiskConfigurationType (Maybe NotifyConfigurationType) #
The notify configuration used to construct email notifications.
atrctActions :: Lens' AccountTakeoverRiskConfigurationType AccountTakeoverActionsType #
Account takeover risk configuration actions
AdminCreateUserConfigType
data AdminCreateUserConfigType #
The configuration for creating a new user profile.
See: adminCreateUserConfigType smart constructor.
Instances
adminCreateUserConfigType :: AdminCreateUserConfigType #
Creates a value of AdminCreateUserConfigType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acuctAllowAdminCreateUserOnly- Set toTrueif only the administrator is allowed to create user profiles. Set toFalseif users can sign themselves up via an app.acuctUnusedAccountValidityDays- The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must callAdminCreateUseragain, specifyingRESENDfor theMessageActionparameter. The default value for this parameter is 7.acuctInviteMessageTemplate- The message template to be used for the welcome message to new users. See also Customizing User Invitation Messages .
acuctAllowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool) #
Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
acuctUnusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural) #
The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying RESEND for the MessageAction parameter. The default value for this parameter is 7.
acuctInviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType) #
The message template to be used for the welcome message to new users. See also Customizing User Invitation Messages .
AnalyticsConfigurationType
data AnalyticsConfigurationType #
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
See: analyticsConfigurationType smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AnalyticsConfigurationType |
Creates a value of AnalyticsConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
actUserDataShared- IfUserDataSharedistrue, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.actApplicationId- The application ID for an Amazon Pinpoint application.actRoleARN- The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.actExternalId- The external ID.
actUserDataShared :: Lens' AnalyticsConfigurationType (Maybe Bool) #
If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
actApplicationId :: Lens' AnalyticsConfigurationType Text #
The application ID for an Amazon Pinpoint application.
actRoleARN :: Lens' AnalyticsConfigurationType Text #
The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
actExternalId :: Lens' AnalyticsConfigurationType Text #
The external ID.
AnalyticsMetadataType
data AnalyticsMetadataType #
An Amazon Pinpoint analytics endpoint.
An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.
See: analyticsMetadataType smart constructor.
Instances
analyticsMetadataType :: AnalyticsMetadataType #
Creates a value of AnalyticsMetadataType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
amtAnalyticsEndpointId- The endpoint ID.
amtAnalyticsEndpointId :: Lens' AnalyticsMetadataType (Maybe Text) #
The endpoint ID.
AttributeType
data AttributeType #
Specifies whether the attribute is standard or custom.
See: attributeType smart constructor.
Instances
Arguments
| :: Text | |
| -> AttributeType |
Creates a value of AttributeType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atName :: Lens' AttributeType Text #
The name of the attribute.
AuthEventType
data AuthEventType #
The authentication event type.
See: authEventType smart constructor.
Instances
authEventType :: AuthEventType #
Creates a value of AuthEventType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aetEventRisk- The event risk.aetEventResponse- The event response.aetEventContextData- The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received.aetChallengeResponses- The challenge responses.aetEventType- The event type.aetCreationDate- The creation dateaetEventFeedback- A flag specifying the user feedback captured at the time of an event request is good or bad.aetEventId- The event ID.
aetEventRisk :: Lens' AuthEventType (Maybe EventRiskType) #
The event risk.
aetEventResponse :: Lens' AuthEventType (Maybe EventResponseType) #
The event response.
aetEventContextData :: Lens' AuthEventType (Maybe EventContextDataType) #
The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received.
aetChallengeResponses :: Lens' AuthEventType [ChallengeResponseType] #
The challenge responses.
aetEventType :: Lens' AuthEventType (Maybe EventType) #
The event type.
aetCreationDate :: Lens' AuthEventType (Maybe UTCTime) #
The creation date
aetEventFeedback :: Lens' AuthEventType (Maybe EventFeedbackType) #
A flag specifying the user feedback captured at the time of an event request is good or bad.
aetEventId :: Lens' AuthEventType (Maybe Text) #
The event ID.
AuthenticationResultType
data AuthenticationResultType #
The authentication result.
See: authenticationResultType smart constructor.
Instances
authenticationResultType :: AuthenticationResultType #
Creates a value of AuthenticationResultType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
artAccessToken- The access token.artRefreshToken- The refresh token.artNewDeviceMetadata- The new device metadata from an authentication result.artExpiresIn- The expiration period of the authentication result.artTokenType- The token type.artIdToken- The ID token.
artAccessToken :: Lens' AuthenticationResultType (Maybe Text) #
The access token.
artRefreshToken :: Lens' AuthenticationResultType (Maybe Text) #
The refresh token.
artNewDeviceMetadata :: Lens' AuthenticationResultType (Maybe NewDeviceMetadataType) #
The new device metadata from an authentication result.
artExpiresIn :: Lens' AuthenticationResultType (Maybe Int) #
The expiration period of the authentication result.
artTokenType :: Lens' AuthenticationResultType (Maybe Text) #
The token type.
artIdToken :: Lens' AuthenticationResultType (Maybe Text) #
The ID token.
ChallengeResponseType
data ChallengeResponseType #
The challenge response type.
See: challengeResponseType smart constructor.
Instances
challengeResponseType :: ChallengeResponseType #
Creates a value of ChallengeResponseType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crtChallengeName- The challenge namecrtChallengeResponse- The challenge response.
crtChallengeName :: Lens' ChallengeResponseType (Maybe ChallengeName) #
The challenge name
crtChallengeResponse :: Lens' ChallengeResponseType (Maybe ChallengeResponse) #
The challenge response.
CodeDeliveryDetailsType
data CodeDeliveryDetailsType #
The code delivery details being returned from the server.
See: codeDeliveryDetailsType smart constructor.
Instances
codeDeliveryDetailsType :: CodeDeliveryDetailsType #
Creates a value of CodeDeliveryDetailsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cddtDestination- The destination for the code delivery details.cddtDeliveryMedium- The delivery medium (email message or phone number).cddtAttributeName- The attribute name.
cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text) #
The destination for the code delivery details.
cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType) #
The delivery medium (email message or phone number).
cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text) #
The attribute name.
CompromisedCredentialsActionsType
data CompromisedCredentialsActionsType #
The compromised credentials actions type
See: compromisedCredentialsActionsType smart constructor.
Instances
compromisedCredentialsActionsType #
Creates a value of CompromisedCredentialsActionsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccatEventAction- The event action.
ccatEventAction :: Lens' CompromisedCredentialsActionsType CompromisedCredentialsEventActionType #
The event action.
CompromisedCredentialsRiskConfigurationType
data CompromisedCredentialsRiskConfigurationType #
The compromised credentials risk configuration type.
See: compromisedCredentialsRiskConfigurationType smart constructor.
Instances
compromisedCredentialsRiskConfigurationType #
Creates a value of CompromisedCredentialsRiskConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccrctEventFilter- Perform the action for these events. The default is to perform all events if no event filter is specified.ccrctActions- The compromised credentials risk configuration actions.
ccrctEventFilter :: Lens' CompromisedCredentialsRiskConfigurationType [EventFilterType] #
Perform the action for these events. The default is to perform all events if no event filter is specified.
ccrctActions :: Lens' CompromisedCredentialsRiskConfigurationType CompromisedCredentialsActionsType #
The compromised credentials risk configuration actions.
ContextDataType
data ContextDataType #
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
See: contextDataType smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ContextDataType |
Creates a value of ContextDataType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdtEncodedData- Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.cdtIPAddress- Source IP address of your user.cdtServerName- Your server endpoint where this API is invoked.cdtServerPath- Your server path where this API is invoked.cdtHTTPHeaders- HttpHeaders received on your server in same order.
cdtEncodedData :: Lens' ContextDataType (Maybe Text) #
Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
cdtIPAddress :: Lens' ContextDataType Text #
Source IP address of your user.
cdtServerName :: Lens' ContextDataType Text #
Your server endpoint where this API is invoked.
cdtServerPath :: Lens' ContextDataType Text #
Your server path where this API is invoked.
cdtHTTPHeaders :: Lens' ContextDataType [HTTPHeader] #
HttpHeaders received on your server in same order.
DeviceConfigurationType
data DeviceConfigurationType #
The configuration for the user pool's device tracking.
See: deviceConfigurationType smart constructor.
Instances
deviceConfigurationType :: DeviceConfigurationType #
Creates a value of DeviceConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dctChallengeRequiredOnNewDevice- Indicates whether a challenge is required on a new device. Only applicable to a new device.dctDeviceOnlyRememberedOnUserPrompt- If true, a device is only remembered on user prompt.
dctChallengeRequiredOnNewDevice :: Lens' DeviceConfigurationType (Maybe Bool) #
Indicates whether a challenge is required on a new device. Only applicable to a new device.
dctDeviceOnlyRememberedOnUserPrompt :: Lens' DeviceConfigurationType (Maybe Bool) #
If true, a device is only remembered on user prompt.
DeviceSecretVerifierConfigType
data DeviceSecretVerifierConfigType #
The device verifier against which it will be authenticated.
See: deviceSecretVerifierConfigType smart constructor.
Instances
deviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType #
Creates a value of DeviceSecretVerifierConfigType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsvctPasswordVerifier- The password verifier.dsvctSalt- The salt.
dsvctPasswordVerifier :: Lens' DeviceSecretVerifierConfigType (Maybe Text) #
The password verifier.
DeviceType
data DeviceType #
The device type.
See: deviceType smart constructor.
Instances
Creates a value of DeviceType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtDeviceLastModifiedDate- The last modified date of the device.dtDeviceCreateDate- The creation date of the device.dtDeviceAttributes- The device attributes.dtDeviceKey- The device key.dtDeviceLastAuthenticatedDate- The date in which the device was last authenticated.
dtDeviceLastModifiedDate :: Lens' DeviceType (Maybe UTCTime) #
The last modified date of the device.
dtDeviceCreateDate :: Lens' DeviceType (Maybe UTCTime) #
The creation date of the device.
dtDeviceAttributes :: Lens' DeviceType [AttributeType] #
The device attributes.
dtDeviceKey :: Lens' DeviceType (Maybe Text) #
The device key.
dtDeviceLastAuthenticatedDate :: Lens' DeviceType (Maybe UTCTime) #
The date in which the device was last authenticated.
DomainDescriptionType
data DomainDescriptionType #
A container for information about a domain.
See: domainDescriptionType smart constructor.
Instances
domainDescriptionType :: DomainDescriptionType #
Creates a value of DomainDescriptionType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddtStatus- The domain status.ddtCloudFrontDistribution- The ARN of the CloudFront distribution.ddtUserPoolId- The user pool ID.ddtDomain- The domain string.ddtAWSAccountId- The AWS account ID for the user pool owner.ddtVersion- The app version.ddtS3Bucket- The S3 bucket where the static files for this domain are stored.
ddtStatus :: Lens' DomainDescriptionType (Maybe DomainStatusType) #
The domain status.
ddtCloudFrontDistribution :: Lens' DomainDescriptionType (Maybe Text) #
The ARN of the CloudFront distribution.
ddtUserPoolId :: Lens' DomainDescriptionType (Maybe Text) #
The user pool ID.
ddtAWSAccountId :: Lens' DomainDescriptionType (Maybe Text) #
The AWS account ID for the user pool owner.
ddtVersion :: Lens' DomainDescriptionType (Maybe Text) #
The app version.
ddtS3Bucket :: Lens' DomainDescriptionType (Maybe Text) #
The S3 bucket where the static files for this domain are stored.
EmailConfigurationType
data EmailConfigurationType #
The email configuration type.
See: emailConfigurationType smart constructor.
Instances
emailConfigurationType :: EmailConfigurationType #
Creates a value of EmailConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ectSourceARN- The Amazon Resource Name (ARN) of the email source.ectReplyToEmailAddress- The destination to which the receiver of the email should reply to.
ectSourceARN :: Lens' EmailConfigurationType (Maybe Text) #
The Amazon Resource Name (ARN) of the email source.
ectReplyToEmailAddress :: Lens' EmailConfigurationType (Maybe Text) #
The destination to which the receiver of the email should reply to.
EventContextDataType
data EventContextDataType #
Specifies the user context data captured at the time of an event request.
See: eventContextDataType smart constructor.
Instances
eventContextDataType :: EventContextDataType #
Creates a value of EventContextDataType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecdtIPAddress- The user's IP address.ecdtCountry- The user's country.ecdtCity- The user's city.ecdtDeviceName- The user's device name.ecdtTimezone- The user's time zone.
ecdtIPAddress :: Lens' EventContextDataType (Maybe Text) #
The user's IP address.
ecdtCountry :: Lens' EventContextDataType (Maybe Text) #
The user's country.
ecdtDeviceName :: Lens' EventContextDataType (Maybe Text) #
The user's device name.
ecdtTimezone :: Lens' EventContextDataType (Maybe Text) #
The user's time zone.
EventFeedbackType
data EventFeedbackType #
Specifies the event feedback type.
See: eventFeedbackType smart constructor.
Instances
Arguments
| :: FeedbackValueType | |
| -> Text | |
| -> EventFeedbackType |
Creates a value of EventFeedbackType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eftFeedbackDate- The event feedback date.eftFeedbackValue- The event feedback value.eftProvider- The provider.
eftFeedbackDate :: Lens' EventFeedbackType (Maybe UTCTime) #
The event feedback date.
eftFeedbackValue :: Lens' EventFeedbackType FeedbackValueType #
The event feedback value.
eftProvider :: Lens' EventFeedbackType Text #
The provider.
EventRiskType
data EventRiskType #
The event risk type.
See: eventRiskType smart constructor.
Instances
eventRiskType :: EventRiskType #
Creates a value of EventRiskType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ertRiskLevel- The risk level.ertRiskDecision- The risk decision.
ertRiskLevel :: Lens' EventRiskType (Maybe RiskLevelType) #
The risk level.
ertRiskDecision :: Lens' EventRiskType (Maybe RiskDecisionType) #
The risk decision.
GroupType
The group type.
See: groupType smart constructor.
Instances
Creates a value of GroupType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtLastModifiedDate- The date the group was last modified.gtUserPoolId- The user pool ID for the user pool.gtCreationDate- The date the group was created.gtPrecedence- A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in thecognito:rolesandcognito:preferred_roleclaims in the user's tokens. Groups with higherPrecedencevalues take precedence over groups with lowerPrecedencevalues or with nullPrecedencevalues. Two groups can have the samePrecedencevalue. If this happens, neither group takes precedence over the other. If two groups with the samePrecedencehave the same role ARN, that role is used in thecognito:preferred_roleclaim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_roleclaim is not set in users' tokens. The defaultPrecedencevalue is null.gtGroupName- The name of the group.gtDescription- A string containing the description of the group.gtRoleARN- The role ARN for the group.
gtPrecedence :: Lens' GroupType (Maybe Natural) #
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens. The default Precedence value is null.
HTTPHeader
data HTTPHeader #
The HTTP header.
See: hTTPHeader smart constructor.
Instances
Creates a value of HTTPHeader with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httphHeaderValue- The header value.httphHeaderName- The header name
httphHeaderValue :: Lens' HTTPHeader (Maybe Text) #
The header value.
httphHeaderName :: Lens' HTTPHeader (Maybe Text) #
The header name
IdentityProviderType
data IdentityProviderType #
A container for information about an identity provider.
See: identityProviderType smart constructor.
Instances
identityProviderType :: IdentityProviderType #
Creates a value of IdentityProviderType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iptLastModifiedDate- The date the identity provider was last modified.iptUserPoolId- The user pool ID.iptProviderType- The identity provider type.iptCreationDate- The date the identity provider was created.iptIdpIdentifiers- A list of identity provider identifiers.iptAttributeMapping- A mapping of identity provider attributes to standard and custom user pool attributes.iptProviderDetails- The identity provider details, such asMetadataURLandMetadataFile.iptProviderName- The identity provider name.
iptLastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime) #
The date the identity provider was last modified.
iptUserPoolId :: Lens' IdentityProviderType (Maybe Text) #
The user pool ID.
iptProviderType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType) #
The identity provider type.
iptCreationDate :: Lens' IdentityProviderType (Maybe UTCTime) #
The date the identity provider was created.
iptIdpIdentifiers :: Lens' IdentityProviderType [Text] #
A list of identity provider identifiers.
iptAttributeMapping :: Lens' IdentityProviderType (HashMap Text Text) #
A mapping of identity provider attributes to standard and custom user pool attributes.
iptProviderDetails :: Lens' IdentityProviderType (HashMap Text Text) #
The identity provider details, such as MetadataURL and MetadataFile .
iptProviderName :: Lens' IdentityProviderType (Maybe Text) #
The identity provider name.
LambdaConfigType
data LambdaConfigType #
Specifies the configuration for AWS Lambda triggers.
See: lambdaConfigType smart constructor.
Instances
lambdaConfigType :: LambdaConfigType #
Creates a value of LambdaConfigType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lctPreAuthentication- A pre-authentication AWS Lambda trigger.lctCreateAuthChallenge- Creates an authentication challenge.lctVerifyAuthChallengeResponse- Verifies the authentication challenge response.lctPostAuthentication- A post-authentication AWS Lambda trigger.lctCustomMessage- A custom Message AWS Lambda trigger.lctDefineAuthChallenge- Defines the authentication challenge.lctPostConfirmation- A post-confirmation AWS Lambda trigger.lctPreTokenGeneration- A Lambda trigger that is invoked before token generation.lctUserMigration- The user migration Lambda config type.lctPreSignUp- A pre-registration AWS Lambda trigger.
lctPreAuthentication :: Lens' LambdaConfigType (Maybe Text) #
A pre-authentication AWS Lambda trigger.
lctCreateAuthChallenge :: Lens' LambdaConfigType (Maybe Text) #
Creates an authentication challenge.
lctVerifyAuthChallengeResponse :: Lens' LambdaConfigType (Maybe Text) #
Verifies the authentication challenge response.
lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text) #
A post-authentication AWS Lambda trigger.
lctCustomMessage :: Lens' LambdaConfigType (Maybe Text) #
A custom Message AWS Lambda trigger.
lctDefineAuthChallenge :: Lens' LambdaConfigType (Maybe Text) #
Defines the authentication challenge.
lctPostConfirmation :: Lens' LambdaConfigType (Maybe Text) #
A post-confirmation AWS Lambda trigger.
lctPreTokenGeneration :: Lens' LambdaConfigType (Maybe Text) #
A Lambda trigger that is invoked before token generation.
lctUserMigration :: Lens' LambdaConfigType (Maybe Text) #
The user migration Lambda config type.
lctPreSignUp :: Lens' LambdaConfigType (Maybe Text) #
A pre-registration AWS Lambda trigger.
MFAOptionType
data MFAOptionType #
Specifies the different settings for multi-factor authentication (MFA).
See: mfaOptionType smart constructor.
Instances
mfaOptionType :: MFAOptionType #
Creates a value of MFAOptionType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
motDeliveryMedium- The delivery medium (email message or SMS message) to send the MFA code.motAttributeName- The attribute name of the MFA option type.
motDeliveryMedium :: Lens' MFAOptionType (Maybe DeliveryMediumType) #
The delivery medium (email message or SMS message) to send the MFA code.
motAttributeName :: Lens' MFAOptionType (Maybe Text) #
The attribute name of the MFA option type.
MessageTemplateType
data MessageTemplateType #
The message template structure.
See: messageTemplateType smart constructor.
Instances
messageTemplateType :: MessageTemplateType #
Creates a value of MessageTemplateType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mttEmailSubject- The subject line for email messages.mttSMSMessage- The message template for SMS messages.mttEmailMessage- The message template for email messages.
mttEmailSubject :: Lens' MessageTemplateType (Maybe Text) #
The subject line for email messages.
mttSMSMessage :: Lens' MessageTemplateType (Maybe Text) #
The message template for SMS messages.
mttEmailMessage :: Lens' MessageTemplateType (Maybe Text) #
The message template for email messages.
NewDeviceMetadataType
data NewDeviceMetadataType #
The new device metadata type.
See: newDeviceMetadataType smart constructor.
Instances
newDeviceMetadataType :: NewDeviceMetadataType #
Creates a value of NewDeviceMetadataType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ndmtDeviceGroupKey- The device group key.ndmtDeviceKey- The device key.
ndmtDeviceGroupKey :: Lens' NewDeviceMetadataType (Maybe Text) #
The device group key.
ndmtDeviceKey :: Lens' NewDeviceMetadataType (Maybe Text) #
The device key.
NotifyConfigurationType
data NotifyConfigurationType #
The notify configuration type.
See: notifyConfigurationType smart constructor.
Instances
Arguments
| :: Text | |
| -> NotifyConfigurationType |
Creates a value of NotifyConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nctNoActionEmail- The email template used when a detected risk event is allowed.nctFrom- The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.nctReplyTo- The destination to which the receiver of an email should reply to.nctBlockEmail- Email template used when a detected risk event is blocked.nctMFAEmail- The MFA email template used when MFA is challenged as part of a detected risk.nctSourceARN- The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in theFromparameter.
nctNoActionEmail :: Lens' NotifyConfigurationType (Maybe NotifyEmailType) #
The email template used when a detected risk event is allowed.
nctFrom :: Lens' NotifyConfigurationType (Maybe Text) #
The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
nctReplyTo :: Lens' NotifyConfigurationType (Maybe Text) #
The destination to which the receiver of an email should reply to.
nctBlockEmail :: Lens' NotifyConfigurationType (Maybe NotifyEmailType) #
Email template used when a detected risk event is blocked.
nctMFAEmail :: Lens' NotifyConfigurationType (Maybe NotifyEmailType) #
The MFA email template used when MFA is challenged as part of a detected risk.
nctSourceARN :: Lens' NotifyConfigurationType Text #
The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter.
NotifyEmailType
data NotifyEmailType #
The notify email type.
See: notifyEmailType smart constructor.
Instances
Arguments
| :: Text | |
| -> NotifyEmailType |
Creates a value of NotifyEmailType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
netTextBody- The text body.netHTMLBody- The HTML body.netSubject- The subject.
netTextBody :: Lens' NotifyEmailType (Maybe Text) #
The text body.
netHTMLBody :: Lens' NotifyEmailType (Maybe Text) #
The HTML body.
netSubject :: Lens' NotifyEmailType Text #
The subject.
NumberAttributeConstraintsType
data NumberAttributeConstraintsType #
The minimum and maximum value of an attribute that is of the number data type.
See: numberAttributeConstraintsType smart constructor.
Instances
numberAttributeConstraintsType :: NumberAttributeConstraintsType #
Creates a value of NumberAttributeConstraintsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nactMaxValue- The maximum value of an attribute that is of the number data type.nactMinValue- The minimum value of an attribute that is of the number data type.
nactMaxValue :: Lens' NumberAttributeConstraintsType (Maybe Text) #
The maximum value of an attribute that is of the number data type.
nactMinValue :: Lens' NumberAttributeConstraintsType (Maybe Text) #
The minimum value of an attribute that is of the number data type.
PasswordPolicyType
data PasswordPolicyType #
The password policy type.
See: passwordPolicyType smart constructor.
Instances
passwordPolicyType :: PasswordPolicyType #
Creates a value of PasswordPolicyType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pptRequireNumbers- In the password policy that you have set, refers to whether you have required users to use at least one number in their password.pptRequireUppercase- In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.pptRequireLowercase- In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.pptMinimumLength- The minimum length of the password policy that you have set. Cannot be less than 6.pptRequireSymbols- In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
pptRequireNumbers :: Lens' PasswordPolicyType (Maybe Bool) #
In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
pptRequireUppercase :: Lens' PasswordPolicyType (Maybe Bool) #
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
pptRequireLowercase :: Lens' PasswordPolicyType (Maybe Bool) #
In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
pptMinimumLength :: Lens' PasswordPolicyType (Maybe Natural) #
The minimum length of the password policy that you have set. Cannot be less than 6.
pptRequireSymbols :: Lens' PasswordPolicyType (Maybe Bool) #
In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
ProviderDescription
data ProviderDescription #
A container for identity provider details.
See: providerDescription smart constructor.
Instances
providerDescription :: ProviderDescription #
Creates a value of ProviderDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdLastModifiedDate- The date the provider was last modified.pdProviderType- The identity provider type.pdCreationDate- The date the provider was added to the user pool.pdProviderName- The identity provider name.
pdLastModifiedDate :: Lens' ProviderDescription (Maybe UTCTime) #
The date the provider was last modified.
pdProviderType :: Lens' ProviderDescription (Maybe IdentityProviderTypeType) #
The identity provider type.
pdCreationDate :: Lens' ProviderDescription (Maybe UTCTime) #
The date the provider was added to the user pool.
pdProviderName :: Lens' ProviderDescription (Maybe Text) #
The identity provider name.
ProviderUserIdentifierType
data ProviderUserIdentifierType #
A container for information about an identity provider for a user pool.
See: providerUserIdentifierType smart constructor.
Instances
providerUserIdentifierType :: ProviderUserIdentifierType #
Creates a value of ProviderUserIdentifierType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
puitProviderAttributeValue- The value of the provider attribute to link to, for example,xxxxx_account.puitProviderAttributeName- The name of the provider attribute to link to, for example,NameID.puitProviderName- The name of the provider, for example, Facebook, Google, or Login with Amazon.
puitProviderAttributeValue :: Lens' ProviderUserIdentifierType (Maybe Text) #
The value of the provider attribute to link to, for example, xxxxx_account .
puitProviderAttributeName :: Lens' ProviderUserIdentifierType (Maybe Text) #
The name of the provider attribute to link to, for example, NameID .
puitProviderName :: Lens' ProviderUserIdentifierType (Maybe Text) #
The name of the provider, for example, Facebook, Google, or Login with Amazon.
ResourceServerScopeType
data ResourceServerScopeType #
A resource server scope.
See: resourceServerScopeType smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ResourceServerScopeType |
Creates a value of ResourceServerScopeType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsstScopeName- The name of the scope.rsstScopeDescription- A description of the scope.
rsstScopeName :: Lens' ResourceServerScopeType Text #
The name of the scope.
rsstScopeDescription :: Lens' ResourceServerScopeType Text #
A description of the scope.
ResourceServerType
data ResourceServerType #
A container for information about a resource server for a user pool.
See: resourceServerType smart constructor.
Instances
resourceServerType :: ResourceServerType #
Creates a value of ResourceServerType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rstUserPoolId- The user pool ID for the user pool that hosts the resource server.rstIdentifier- The identifier for the resource server.rstScopes- A list of scopes that are defined for the resource server.rstName- The name of the resource server.
rstUserPoolId :: Lens' ResourceServerType (Maybe Text) #
The user pool ID for the user pool that hosts the resource server.
rstIdentifier :: Lens' ResourceServerType (Maybe Text) #
The identifier for the resource server.
rstScopes :: Lens' ResourceServerType [ResourceServerScopeType] #
A list of scopes that are defined for the resource server.
RiskConfigurationType
data RiskConfigurationType #
The risk configuration type.
See: riskConfigurationType smart constructor.
Instances
riskConfigurationType :: RiskConfigurationType #
Creates a value of RiskConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rctRiskExceptionConfiguration- The configuration to override the risk decision.rctClientId- The app client ID.rctAccountTakeoverRiskConfiguration- The account takeover risk configuration object including theNotifyConfigurationobject andActionsto take in the case of an account takeover.rctLastModifiedDate- The last modified date.rctUserPoolId- The user pool ID.rctCompromisedCredentialsRiskConfiguration- The compromised credentials risk configuration object including theEventFilterand theEventAction
rctRiskExceptionConfiguration :: Lens' RiskConfigurationType (Maybe RiskExceptionConfigurationType) #
The configuration to override the risk decision.
rctClientId :: Lens' RiskConfigurationType (Maybe Text) #
The app client ID.
rctAccountTakeoverRiskConfiguration :: Lens' RiskConfigurationType (Maybe AccountTakeoverRiskConfigurationType) #
The account takeover risk configuration object including the NotifyConfiguration object and Actions to take in the case of an account takeover.
rctLastModifiedDate :: Lens' RiskConfigurationType (Maybe UTCTime) #
The last modified date.
rctUserPoolId :: Lens' RiskConfigurationType (Maybe Text) #
The user pool ID.
rctCompromisedCredentialsRiskConfiguration :: Lens' RiskConfigurationType (Maybe CompromisedCredentialsRiskConfigurationType) #
The compromised credentials risk configuration object including the EventFilter and the EventAction
RiskExceptionConfigurationType
data RiskExceptionConfigurationType #
The type of the configuration to override the risk decision.
See: riskExceptionConfigurationType smart constructor.
Instances
riskExceptionConfigurationType :: RiskExceptionConfigurationType #
Creates a value of RiskExceptionConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rectSkippedIPRangeList- Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.rectBlockedIPRangeList- Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.
rectSkippedIPRangeList :: Lens' RiskExceptionConfigurationType [Text] #
Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.
rectBlockedIPRangeList :: Lens' RiskExceptionConfigurationType [Text] #
Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.
SMSMFASettingsType
data SMSMFASettingsType #
The SMS multi-factor authentication (MFA) settings type.
See: sMSMFASettingsType smart constructor.
Instances
sMSMFASettingsType :: SMSMFASettingsType #
Creates a value of SMSMFASettingsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smsmstEnabled- Specifies whether SMS text message MFA is enabled.smsmstPreferredMFA- The preferred MFA method.
smsmstEnabled :: Lens' SMSMFASettingsType (Maybe Bool) #
Specifies whether SMS text message MFA is enabled.
smsmstPreferredMFA :: Lens' SMSMFASettingsType (Maybe Bool) #
The preferred MFA method.
SchemaAttributeType
data SchemaAttributeType #
Contains information about the schema attribute.
See: schemaAttributeType smart constructor.
Instances
schemaAttributeType :: SchemaAttributeType #
Creates a value of SchemaAttributeType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
satNumberAttributeConstraints- Specifies the constraints for an attribute of the number type.satRequired- Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.satAttributeDataType- The attribute data type.satStringAttributeConstraints- Specifies the constraints for an attribute of the string type.satName- A schema attribute of the name type.satDeveloperOnlyAttribute- Specifies whether the attribute type is developer only.satMutable- Specifies whether the attribute can be changed once it has been created.
satNumberAttributeConstraints :: Lens' SchemaAttributeType (Maybe NumberAttributeConstraintsType) #
Specifies the constraints for an attribute of the number type.
satRequired :: Lens' SchemaAttributeType (Maybe Bool) #
Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
satAttributeDataType :: Lens' SchemaAttributeType (Maybe AttributeDataType) #
The attribute data type.
satStringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType) #
Specifies the constraints for an attribute of the string type.
satDeveloperOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool) #
Specifies whether the attribute type is developer only.
satMutable :: Lens' SchemaAttributeType (Maybe Bool) #
Specifies whether the attribute can be changed once it has been created.
SmsConfigurationType
data SmsConfigurationType #
The SMS configuration type.
See: smsConfigurationType smart constructor.
Instances
Arguments
| :: Text | |
| -> SmsConfigurationType |
Creates a value of SmsConfigurationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sctExternalId- The external ID.sctSNSCallerARN- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.
sctExternalId :: Lens' SmsConfigurationType (Maybe Text) #
The external ID.
sctSNSCallerARN :: Lens' SmsConfigurationType Text #
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.
SmsMFAConfigType
data SmsMFAConfigType #
The SMS text message multi-factor authentication (MFA) configuration type.
See: smsMFAConfigType smart constructor.
Instances
smsMFAConfigType :: SmsMFAConfigType #
Creates a value of SmsMFAConfigType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smctSmsAuthenticationMessage- The SMS authentication message.smctSmsConfiguration- The SMS configuration.
smctSmsAuthenticationMessage :: Lens' SmsMFAConfigType (Maybe Text) #
The SMS authentication message.
smctSmsConfiguration :: Lens' SmsMFAConfigType (Maybe SmsConfigurationType) #
The SMS configuration.
SoftwareTokenMFAConfigType
data SoftwareTokenMFAConfigType #
The type used for enabling software token MFA at the user pool level.
See: softwareTokenMFAConfigType smart constructor.
Instances
softwareTokenMFAConfigType :: SoftwareTokenMFAConfigType #
Creates a value of SoftwareTokenMFAConfigType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stmctEnabled- Specifies whether software token MFA is enabled.
stmctEnabled :: Lens' SoftwareTokenMFAConfigType (Maybe Bool) #
Specifies whether software token MFA is enabled.
SoftwareTokenMFASettingsType
data SoftwareTokenMFASettingsType #
The type used for enabling software token MFA at the user level.
See: softwareTokenMFASettingsType smart constructor.
Instances
softwareTokenMFASettingsType :: SoftwareTokenMFASettingsType #
Creates a value of SoftwareTokenMFASettingsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stmstEnabled- Specifies whether software token MFA is enabled.stmstPreferredMFA- The preferred MFA method.
stmstEnabled :: Lens' SoftwareTokenMFASettingsType (Maybe Bool) #
Specifies whether software token MFA is enabled.
stmstPreferredMFA :: Lens' SoftwareTokenMFASettingsType (Maybe Bool) #
The preferred MFA method.
StringAttributeConstraintsType
data StringAttributeConstraintsType #
The constraints associated with a string attribute.
See: stringAttributeConstraintsType smart constructor.
Instances
stringAttributeConstraintsType :: StringAttributeConstraintsType #
Creates a value of StringAttributeConstraintsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sactMaxLength- The maximum length.sactMinLength- The minimum length.
sactMaxLength :: Lens' StringAttributeConstraintsType (Maybe Text) #
The maximum length.
sactMinLength :: Lens' StringAttributeConstraintsType (Maybe Text) #
The minimum length.
UICustomizationType
data UICustomizationType #
A container for the UI customization information for a user pool's built-in app UI.
See: uICustomizationType smart constructor.
Instances
uICustomizationType :: UICustomizationType #
Creates a value of UICustomizationType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uictClientId- The client ID for the client app.uictLastModifiedDate- The last-modified date for the UI customization.uictUserPoolId- The user pool ID for the user pool.uictCSS- The CSS values in the UI customization.uictCSSVersion- The CSS version number.uictImageURL- The logo image for the UI customization.uictCreationDate- The creation date for the UI customization.
uictClientId :: Lens' UICustomizationType (Maybe Text) #
The client ID for the client app.
uictLastModifiedDate :: Lens' UICustomizationType (Maybe UTCTime) #
The last-modified date for the UI customization.
uictUserPoolId :: Lens' UICustomizationType (Maybe Text) #
The user pool ID for the user pool.
uictCSSVersion :: Lens' UICustomizationType (Maybe Text) #
The CSS version number.
uictImageURL :: Lens' UICustomizationType (Maybe Text) #
The logo image for the UI customization.
uictCreationDate :: Lens' UICustomizationType (Maybe UTCTime) #
The creation date for the UI customization.
UserContextDataType
data UserContextDataType #
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
See: userContextDataType smart constructor.
Instances
userContextDataType :: UserContextDataType #
Creates a value of UserContextDataType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ucdtEncodedData- Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
ucdtEncodedData :: Lens' UserContextDataType (Maybe Text) #
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
UserImportJobType
data UserImportJobType #
The user import job type.
See: userImportJobType smart constructor.
Instances
userImportJobType :: UserImportJobType #
Creates a value of UserImportJobType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uijtStatus- The status of the user import job. One of the following: *Created- The job was created but not started. *Pending- A transition state. You have started the job, but it has not begun importing users yet. *InProgress- The job has started, and users are being imported. *Stopping- You have stopped the job, but the job has not stopped importing users yet. *Stopped- You have stopped the job, and the job has stopped importing users. *Succeeded- The job has completed successfully. *Failed- The job has stopped due to an error. *Expired- You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.uijtSkippedUsers- The number of users that were skipped.uijtJobId- The job ID for the user import job.uijtUserPoolId- The user pool ID for the user pool that the users are being imported into.uijtJobName- The job name for the user import job.uijtPreSignedURL- The pre-signed URL to be used to upload the.csvfile.uijtFailedUsers- The number of users that could not be imported.uijtStartDate- The date when the user import job was started.uijtCompletionMessage- The message returned when the user import job is completed.uijtCreationDate- The date the user import job was created.uijtCompletionDate- The date when the user import job was completed.uijtCloudWatchLogsRoleARN- The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.uijtImportedUsers- The number of users that were successfully imported.
uijtStatus :: Lens' UserImportJobType (Maybe UserImportJobStatusType) #
The status of the user import job. One of the following: * Created - The job was created but not started. * Pending - A transition state. You have started the job, but it has not begun importing users yet. * InProgress - The job has started, and users are being imported. * Stopping - You have stopped the job, but the job has not stopped importing users yet. * Stopped - You have stopped the job, and the job has stopped importing users. * Succeeded - The job has completed successfully. * Failed - The job has stopped due to an error. * Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.
uijtSkippedUsers :: Lens' UserImportJobType (Maybe Integer) #
The number of users that were skipped.
uijtUserPoolId :: Lens' UserImportJobType (Maybe Text) #
The user pool ID for the user pool that the users are being imported into.
uijtJobName :: Lens' UserImportJobType (Maybe Text) #
The job name for the user import job.
uijtPreSignedURL :: Lens' UserImportJobType (Maybe Text) #
The pre-signed URL to be used to upload the .csv file.
uijtFailedUsers :: Lens' UserImportJobType (Maybe Integer) #
The number of users that could not be imported.
uijtStartDate :: Lens' UserImportJobType (Maybe UTCTime) #
The date when the user import job was started.
uijtCompletionMessage :: Lens' UserImportJobType (Maybe Text) #
The message returned when the user import job is completed.
uijtCreationDate :: Lens' UserImportJobType (Maybe UTCTime) #
The date the user import job was created.
uijtCompletionDate :: Lens' UserImportJobType (Maybe UTCTime) #
The date when the user import job was completed.
uijtCloudWatchLogsRoleARN :: Lens' UserImportJobType (Maybe Text) #
The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
uijtImportedUsers :: Lens' UserImportJobType (Maybe Integer) #
The number of users that were successfully imported.
UserPoolAddOnsType
data UserPoolAddOnsType #
The user pool add-ons type.
See: userPoolAddOnsType smart constructor.
Instances
Creates a value of UserPoolAddOnsType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upaotAdvancedSecurityMode- The advanced security mode.
upaotAdvancedSecurityMode :: Lens' UserPoolAddOnsType AdvancedSecurityModeType #
The advanced security mode.
UserPoolClientDescription
data UserPoolClientDescription #
The description of the user pool client.
See: userPoolClientDescription smart constructor.
Instances
userPoolClientDescription :: UserPoolClientDescription #
Creates a value of UserPoolClientDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upcdClientId- The ID of the client associated with the user pool.upcdUserPoolId- The user pool ID for the user pool where you want to describe the user pool client.upcdClientName- The client name from the user pool client description.
upcdClientId :: Lens' UserPoolClientDescription (Maybe Text) #
The ID of the client associated with the user pool.
upcdUserPoolId :: Lens' UserPoolClientDescription (Maybe Text) #
The user pool ID for the user pool where you want to describe the user pool client.
upcdClientName :: Lens' UserPoolClientDescription (Maybe Text) #
The client name from the user pool client description.
UserPoolClientType
data UserPoolClientType #
Contains information about a user pool client.
See: userPoolClientType smart constructor.
Instances
userPoolClientType :: UserPoolClientType #
Creates a value of UserPoolClientType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upctRefreshTokenValidity- The time limit, in days, after which the refresh token is no longer valid and cannot be used.upctClientId- The ID of the client associated with the user pool.upctExplicitAuthFlows- The explicit authentication flows.upctClientSecret- The client secret from the user pool request of the client type.upctLastModifiedDate- The date the user pool client was last modified.upctSupportedIdentityProviders- A list of provider names for the identity providers that are supported on this client.upctLogoutURLs- A list of allowed logout URLs for the identity providers.upctAllowedOAuthFlowsUserPoolClient- Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.upctUserPoolId- The user pool ID for the user pool client.upctDefaultRedirectURI- The default redirect URI. Must be in theCallbackURLslist.upctWriteAttributes- The writeable attributes.upctCreationDate- The date the user pool client was created.upctReadAttributes- The Read-only attributes.upctAllowedOAuthScopes- A list of allowedOAuthscopes. Currently supported values are"phone","email","openid", andCognito.upctAllowedOAuthFlows- Set tocodeto initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set totokento specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.upctAnalyticsConfiguration- The Amazon Pinpoint analytics configuration for the user pool client.upctClientName- The client name from the user pool request of the client type.upctCallbackURLs- A list of allowed callback URLs for the identity providers.
upctRefreshTokenValidity :: Lens' UserPoolClientType (Maybe Natural) #
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
upctClientId :: Lens' UserPoolClientType (Maybe Text) #
The ID of the client associated with the user pool.
upctExplicitAuthFlows :: Lens' UserPoolClientType [ExplicitAuthFlowsType] #
The explicit authentication flows.
upctClientSecret :: Lens' UserPoolClientType (Maybe Text) #
The client secret from the user pool request of the client type.
upctLastModifiedDate :: Lens' UserPoolClientType (Maybe UTCTime) #
The date the user pool client was last modified.
upctSupportedIdentityProviders :: Lens' UserPoolClientType [Text] #
A list of provider names for the identity providers that are supported on this client.
upctLogoutURLs :: Lens' UserPoolClientType [Text] #
A list of allowed logout URLs for the identity providers.
upctAllowedOAuthFlowsUserPoolClient :: Lens' UserPoolClientType (Maybe Bool) #
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
upctUserPoolId :: Lens' UserPoolClientType (Maybe Text) #
The user pool ID for the user pool client.
upctDefaultRedirectURI :: Lens' UserPoolClientType (Maybe Text) #
The default redirect URI. Must be in the CallbackURLs list.
upctWriteAttributes :: Lens' UserPoolClientType [Text] #
The writeable attributes.
upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime) #
The date the user pool client was created.
upctReadAttributes :: Lens' UserPoolClientType [Text] #
The Read-only attributes.
upctAllowedOAuthScopes :: Lens' UserPoolClientType [Text] #
A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and Cognito .
upctAllowedOAuthFlows :: Lens' UserPoolClientType [OAuthFlowType] #
Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
upctAnalyticsConfiguration :: Lens' UserPoolClientType (Maybe AnalyticsConfigurationType) #
The Amazon Pinpoint analytics configuration for the user pool client.
upctClientName :: Lens' UserPoolClientType (Maybe Text) #
The client name from the user pool request of the client type.
upctCallbackURLs :: Lens' UserPoolClientType [Text] #
A list of allowed callback URLs for the identity providers.
UserPoolDescriptionType
data UserPoolDescriptionType #
A user pool description.
See: userPoolDescriptionType smart constructor.
Instances
userPoolDescriptionType :: UserPoolDescriptionType #
Creates a value of UserPoolDescriptionType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
updtStatus- The user pool status in a user pool description.updtLastModifiedDate- The date the user pool description was last modified.updtName- The name in a user pool description.updtId- The ID in a user pool description.updtCreationDate- The date the user pool description was created.updtLambdaConfig- The AWS Lambda configuration information in a user pool description.
updtStatus :: Lens' UserPoolDescriptionType (Maybe StatusType) #
The user pool status in a user pool description.
updtLastModifiedDate :: Lens' UserPoolDescriptionType (Maybe UTCTime) #
The date the user pool description was last modified.
updtCreationDate :: Lens' UserPoolDescriptionType (Maybe UTCTime) #
The date the user pool description was created.
updtLambdaConfig :: Lens' UserPoolDescriptionType (Maybe LambdaConfigType) #
The AWS Lambda configuration information in a user pool description.
UserPoolPolicyType
data UserPoolPolicyType #
The policy associated with a user pool.
See: userPoolPolicyType smart constructor.
Instances
userPoolPolicyType :: UserPoolPolicyType #
Creates a value of UserPoolPolicyType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upptPasswordPolicy- The password policy.
upptPasswordPolicy :: Lens' UserPoolPolicyType (Maybe PasswordPolicyType) #
The password policy.
UserPoolType
data UserPoolType #
A container for information about the user pool.
See: userPoolType smart constructor.
Instances
userPoolType :: UserPoolType #
Creates a value of UserPoolType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uptStatus- The status of a user pool.uptUserPoolTags- The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User PooluptEmailConfigurationFailure- The reason why the email configuration cannot send the messages to your users.uptLastModifiedDate- The date the user pool was last modified.uptVerificationMessageTemplate- The template for verification messages.uptEstimatedNumberOfUsers- A number estimating the size of the user pool.uptDomain- Holds the domain prefix if the user pool has a domain associated with it.uptEmailVerificationMessage- The contents of the email verification message.uptSmsAuthenticationMessage- The contents of the SMS authentication message.uptUserPoolAddOns- The user pool add-ons.uptSchemaAttributes- A container with the schema attributes of a user pool.uptEmailVerificationSubject- The subject of the email verification message.uptUsernameAttributes- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.uptAliasAttributes- Specifies the attributes that are aliased in a user pool.uptEmailConfiguration- The email configuration.uptSmsVerificationMessage- The contents of the SMS verification message.uptName- The name of the user pool.uptMFAConfiguration- Can be one of the following values: *OFF- MFA tokens are not required and cannot be specified during user registration. *ON- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. *OPTIONAL- Users have the option when registering to create an MFA token.uptId- The ID of the user pool.uptSmsConfigurationFailure- The reason why the SMS configuration cannot send the messages to your users.uptCreationDate- The date the user pool was created.uptLambdaConfig- The AWS Lambda triggers associated with tue user pool.uptSmsConfiguration- The SMS configuration.uptAdminCreateUserConfig- The configuration forAdminCreateUserrequests.uptDeviceConfiguration- The device configuration.uptAutoVerifiedAttributes- Specifies the attributes that are auto-verified in a user pool.uptPolicies- The policies associated with the user pool.
uptStatus :: Lens' UserPoolType (Maybe StatusType) #
The status of a user pool.
uptUserPoolTags :: Lens' UserPoolType (HashMap Text Text) #
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
uptEmailConfigurationFailure :: Lens' UserPoolType (Maybe Text) #
The reason why the email configuration cannot send the messages to your users.
uptLastModifiedDate :: Lens' UserPoolType (Maybe UTCTime) #
The date the user pool was last modified.
uptVerificationMessageTemplate :: Lens' UserPoolType (Maybe VerificationMessageTemplateType) #
The template for verification messages.
uptEstimatedNumberOfUsers :: Lens' UserPoolType (Maybe Int) #
A number estimating the size of the user pool.
uptDomain :: Lens' UserPoolType (Maybe Text) #
Holds the domain prefix if the user pool has a domain associated with it.
uptEmailVerificationMessage :: Lens' UserPoolType (Maybe Text) #
The contents of the email verification message.
uptSmsAuthenticationMessage :: Lens' UserPoolType (Maybe Text) #
The contents of the SMS authentication message.
uptUserPoolAddOns :: Lens' UserPoolType (Maybe UserPoolAddOnsType) #
The user pool add-ons.
uptSchemaAttributes :: Lens' UserPoolType (Maybe (NonEmpty SchemaAttributeType)) #
A container with the schema attributes of a user pool.
uptEmailVerificationSubject :: Lens' UserPoolType (Maybe Text) #
The subject of the email verification message.
uptUsernameAttributes :: Lens' UserPoolType [UsernameAttributeType] #
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
uptAliasAttributes :: Lens' UserPoolType [AliasAttributeType] #
Specifies the attributes that are aliased in a user pool.
uptEmailConfiguration :: Lens' UserPoolType (Maybe EmailConfigurationType) #
The email configuration.
uptSmsVerificationMessage :: Lens' UserPoolType (Maybe Text) #
The contents of the SMS verification message.
uptMFAConfiguration :: Lens' UserPoolType (Maybe UserPoolMFAType) #
Can be one of the following values: * OFF - MFA tokens are not required and cannot be specified during user registration. * ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. * OPTIONAL - Users have the option when registering to create an MFA token.
uptSmsConfigurationFailure :: Lens' UserPoolType (Maybe Text) #
The reason why the SMS configuration cannot send the messages to your users.
uptCreationDate :: Lens' UserPoolType (Maybe UTCTime) #
The date the user pool was created.
uptLambdaConfig :: Lens' UserPoolType (Maybe LambdaConfigType) #
The AWS Lambda triggers associated with tue user pool.
uptSmsConfiguration :: Lens' UserPoolType (Maybe SmsConfigurationType) #
The SMS configuration.
uptAdminCreateUserConfig :: Lens' UserPoolType (Maybe AdminCreateUserConfigType) #
The configuration for AdminCreateUser requests.
uptDeviceConfiguration :: Lens' UserPoolType (Maybe DeviceConfigurationType) #
The device configuration.
uptAutoVerifiedAttributes :: Lens' UserPoolType [VerifiedAttributeType] #
Specifies the attributes that are auto-verified in a user pool.
uptPolicies :: Lens' UserPoolType (Maybe UserPoolPolicyType) #
The policies associated with the user pool.
UserType
The user type.
See: userType smart constructor.
Instances
Creates a value of UserType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
utEnabled- Specifies whether the user is enabled.utUserStatus- The user status. Can be one of the following: * UNCONFIRMED - User has been created but not confirmed. * CONFIRMED - User has been confirmed. * ARCHIVED - User is no longer active. * COMPROMISED - User is disabled due to a potential security threat. * UNKNOWN - User status is not known.utUsername- The user name of the user you wish to describe.utUserCreateDate- The creation date of the user.utAttributes- A container with information about the user type attributes.utMFAOptions- The MFA options for the user.utUserLastModifiedDate- The last modified date of the user.
utUserStatus :: Lens' UserType (Maybe UserStatusType) #
The user status. Can be one of the following: * UNCONFIRMED - User has been created but not confirmed. * CONFIRMED - User has been confirmed. * ARCHIVED - User is no longer active. * COMPROMISED - User is disabled due to a potential security threat. * UNKNOWN - User status is not known.
utAttributes :: Lens' UserType [AttributeType] #
A container with information about the user type attributes.
utMFAOptions :: Lens' UserType [MFAOptionType] #
The MFA options for the user.
VerificationMessageTemplateType
data VerificationMessageTemplateType #
The template for verification messages.
See: verificationMessageTemplateType smart constructor.
Instances
verificationMessageTemplateType :: VerificationMessageTemplateType #
Creates a value of VerificationMessageTemplateType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vmttDefaultEmailOption- The default email option.vmttEmailSubject- The subject line for the email message template.vmttEmailSubjectByLink- The subject line for the email message template for sending a confirmation link to the user.vmttSmsMessage- The SMS message template.vmttEmailMessageByLink- The email message template for sending a confirmation link to the user.vmttEmailMessage- The email message template.
vmttDefaultEmailOption :: Lens' VerificationMessageTemplateType (Maybe DefaultEmailOptionType) #
The default email option.
vmttEmailSubject :: Lens' VerificationMessageTemplateType (Maybe Text) #
The subject line for the email message template.
vmttEmailSubjectByLink :: Lens' VerificationMessageTemplateType (Maybe Text) #
The subject line for the email message template for sending a confirmation link to the user.
vmttSmsMessage :: Lens' VerificationMessageTemplateType (Maybe Text) #
The SMS message template.
vmttEmailMessageByLink :: Lens' VerificationMessageTemplateType (Maybe Text) #
The email message template for sending a confirmation link to the user.
vmttEmailMessage :: Lens' VerificationMessageTemplateType (Maybe Text) #
The email message template.