Copyright | (c) 2013-2017 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 |
- Service Configuration
- Errors
- UnsupportedUserStateException
- PasswordResetRequiredException
- InvalidParameterException
- InvalidLambdaResponseException
- InvalidEmailRoleAccessPolicyException
- UnsupportedIdentityProviderException
- UserNotFoundException
- UnexpectedLambdaException
- NotAuthorizedException
- InternalErrorException
- InvalidUserPoolConfigurationException
- InvalidSmsRoleAccessPolicyException
- InvalidOAuthFlowException
- CodeMismatchException
- UserImportInProgressException
- InvalidSmsRoleTrustRelationshipException
- UserPoolTaggingException
- TooManyRequestsException
- ConcurrentModificationException
- UserLambdaValidationException
- PreconditionNotMetException
- ExpiredCodeException
- TooManyFailedAttemptsException
- UserNotConfirmedException
- GroupExistsException
- CodeDeliveryFailureException
- ScopeDoesNotExistException
- ResourceNotFoundException
- MFAMethodNotFoundException
- AliasExistsException
- DuplicateProviderException
- LimitExceededException
- InvalidPasswordException
- UsernameExistsException
- Waiters
- Operations
- DeleteUserPool
- UpdateUserPool
- DeleteUserPoolDomain
- AdminInitiateAuth
- AdminLinkProviderForUser
- AdminEnableUser
- GetUserAttributeVerificationCode
- UpdateUserAttributes
- DeleteUserAttributes
- VerifyUserAttribute
- AdminDisableUser
- ConfirmDevice
- ConfirmForgotPassword
- ListUserImportJobs
- DescribeIdentityProvider
- ListUsers
- AdminDeleteUserAttributes
- DescribeUserPoolDomain
- AdminUpdateUserAttributes
- AdminGetUser
- AdminUserGlobalSignOut
- ListUsersInGroup
- AdminDisableProviderForUser
- ForgotPassword
- DescribeUserPool
- InitiateAuth
- AdminListGroupsForUser
- AdminConfirmSignUp
- StartUserImportJob
- CreateIdentityProvider
- SetUICustomization
- ListIdentityProviders
- GetDevice
- SignUp
- DeleteResourceServer
- UpdateResourceServer
- ChangePassword
- CreateUserPoolDomain
- RespondToAuthChallenge
- CreateUserPool
- AdminGetDevice
- GetIdentityProviderByIdentifier
- AdminRemoveUserFromGroup
- ConfirmSignUp
- ListUserPools
- AdminResetUserPassword
- CreateUserImportJob
- GetUser
- GetUICustomization
- GetCSVHeader
- AdminDeleteUser
- AdminForgetDevice
- DescribeResourceServer
- AdminUpdateDeviceStatus
- AdminCreateUser
- AddCustomAttributes
- ListUserPoolClients
- UpdateUserPoolClient
- DeleteUserPoolClient
- UpdateDeviceStatus
- ForgetDevice
- DeleteUser
- CreateUserPoolClient
- CreateResourceServer
- CreateGroup
- AdminAddUserToGroup
- StopUserImportJob
- DescribeUserImportJob
- DeleteGroup
- UpdateGroup
- GlobalSignOut
- ListGroups
- UpdateIdentityProvider
- DeleteIdentityProvider
- ListResourceServers
- AdminRespondToAuthChallenge
- SetUserSettings
- AdminListDevices
- DescribeUserPoolClient
- ResendConfirmationCode
- GetGroup
- AdminSetUserSettings
- ListDevices
- Types
- AliasAttributeType
- AttributeDataType
- AuthFlowType
- ChallengeNameType
- DefaultEmailOptionType
- DeliveryMediumType
- DeviceRememberedStatusType
- DomainStatusType
- ExplicitAuthFlowsType
- IdentityProviderTypeType
- MessageActionType
- OAuthFlowType
- StatusType
- UserImportJobStatusType
- UserPoolMFAType
- UserStatusType
- UsernameAttributeType
- VerifiedAttributeType
- AdminCreateUserConfigType
- AttributeType
- AuthenticationResultType
- CodeDeliveryDetailsType
- DeviceConfigurationType
- DeviceSecretVerifierConfigType
- DeviceType
- DomainDescriptionType
- EmailConfigurationType
- GroupType
- IdentityProviderType
- LambdaConfigType
- MFAOptionType
- MessageTemplateType
- NewDeviceMetadataType
- NumberAttributeConstraintsType
- PasswordPolicyType
- ProviderDescription
- ProviderUserIdentifierType
- ResourceServerScopeType
- ResourceServerType
- SchemaAttributeType
- SmsConfigurationType
- StringAttributeConstraintsType
- UICustomizationType
- UserImportJobType
- UserPoolClientDescription
- UserPoolClientType
- UserPoolDescriptionType
- UserPoolPolicyType
- UserPoolType
- UserType
- VerificationMessageTemplateType
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
- 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
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: 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
- _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
- module Network.AWS.CognitoIdentityProvider.DeleteUserPool
- module Network.AWS.CognitoIdentityProvider.UpdateUserPool
- module Network.AWS.CognitoIdentityProvider.DeleteUserPoolDomain
- module Network.AWS.CognitoIdentityProvider.AdminInitiateAuth
- module Network.AWS.CognitoIdentityProvider.AdminLinkProviderForUser
- module Network.AWS.CognitoIdentityProvider.AdminEnableUser
- module Network.AWS.CognitoIdentityProvider.GetUserAttributeVerificationCode
- module Network.AWS.CognitoIdentityProvider.UpdateUserAttributes
- module Network.AWS.CognitoIdentityProvider.DeleteUserAttributes
- module Network.AWS.CognitoIdentityProvider.VerifyUserAttribute
- module Network.AWS.CognitoIdentityProvider.AdminDisableUser
- module Network.AWS.CognitoIdentityProvider.ConfirmDevice
- module Network.AWS.CognitoIdentityProvider.ConfirmForgotPassword
- module Network.AWS.CognitoIdentityProvider.ListUserImportJobs
- module Network.AWS.CognitoIdentityProvider.DescribeIdentityProvider
- module Network.AWS.CognitoIdentityProvider.ListUsers
- module Network.AWS.CognitoIdentityProvider.AdminDeleteUserAttributes
- module Network.AWS.CognitoIdentityProvider.DescribeUserPoolDomain
- module Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes
- module Network.AWS.CognitoIdentityProvider.AdminGetUser
- module Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut
- module Network.AWS.CognitoIdentityProvider.ListUsersInGroup
- module Network.AWS.CognitoIdentityProvider.AdminDisableProviderForUser
- module Network.AWS.CognitoIdentityProvider.ForgotPassword
- module Network.AWS.CognitoIdentityProvider.DescribeUserPool
- module Network.AWS.CognitoIdentityProvider.InitiateAuth
- module Network.AWS.CognitoIdentityProvider.AdminListGroupsForUser
- module Network.AWS.CognitoIdentityProvider.AdminConfirmSignUp
- module Network.AWS.CognitoIdentityProvider.StartUserImportJob
- module Network.AWS.CognitoIdentityProvider.CreateIdentityProvider
- module Network.AWS.CognitoIdentityProvider.SetUICustomization
- module Network.AWS.CognitoIdentityProvider.ListIdentityProviders
- module Network.AWS.CognitoIdentityProvider.GetDevice
- module Network.AWS.CognitoIdentityProvider.SignUp
- module Network.AWS.CognitoIdentityProvider.DeleteResourceServer
- module Network.AWS.CognitoIdentityProvider.UpdateResourceServer
- module Network.AWS.CognitoIdentityProvider.ChangePassword
- module Network.AWS.CognitoIdentityProvider.CreateUserPoolDomain
- module Network.AWS.CognitoIdentityProvider.RespondToAuthChallenge
- module Network.AWS.CognitoIdentityProvider.CreateUserPool
- module Network.AWS.CognitoIdentityProvider.AdminGetDevice
- module Network.AWS.CognitoIdentityProvider.GetIdentityProviderByIdentifier
- module Network.AWS.CognitoIdentityProvider.AdminRemoveUserFromGroup
- module Network.AWS.CognitoIdentityProvider.ConfirmSignUp
- module Network.AWS.CognitoIdentityProvider.ListUserPools
- module Network.AWS.CognitoIdentityProvider.AdminResetUserPassword
- module Network.AWS.CognitoIdentityProvider.CreateUserImportJob
- module Network.AWS.CognitoIdentityProvider.GetUser
- module Network.AWS.CognitoIdentityProvider.GetUICustomization
- module Network.AWS.CognitoIdentityProvider.GetCSVHeader
- module Network.AWS.CognitoIdentityProvider.AdminDeleteUser
- module Network.AWS.CognitoIdentityProvider.AdminForgetDevice
- module Network.AWS.CognitoIdentityProvider.DescribeResourceServer
- module Network.AWS.CognitoIdentityProvider.AdminUpdateDeviceStatus
- module Network.AWS.CognitoIdentityProvider.AdminCreateUser
- module Network.AWS.CognitoIdentityProvider.AddCustomAttributes
- module Network.AWS.CognitoIdentityProvider.ListUserPoolClients
- module Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient
- module Network.AWS.CognitoIdentityProvider.DeleteUserPoolClient
- module Network.AWS.CognitoIdentityProvider.UpdateDeviceStatus
- module Network.AWS.CognitoIdentityProvider.ForgetDevice
- module Network.AWS.CognitoIdentityProvider.DeleteUser
- module Network.AWS.CognitoIdentityProvider.CreateUserPoolClient
- module Network.AWS.CognitoIdentityProvider.CreateResourceServer
- module Network.AWS.CognitoIdentityProvider.CreateGroup
- module Network.AWS.CognitoIdentityProvider.AdminAddUserToGroup
- module Network.AWS.CognitoIdentityProvider.StopUserImportJob
- module Network.AWS.CognitoIdentityProvider.DescribeUserImportJob
- module Network.AWS.CognitoIdentityProvider.DeleteGroup
- module Network.AWS.CognitoIdentityProvider.UpdateGroup
- module Network.AWS.CognitoIdentityProvider.GlobalSignOut
- module Network.AWS.CognitoIdentityProvider.ListGroups
- module Network.AWS.CognitoIdentityProvider.UpdateIdentityProvider
- module Network.AWS.CognitoIdentityProvider.DeleteIdentityProvider
- module Network.AWS.CognitoIdentityProvider.ListResourceServers
- module Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge
- module Network.AWS.CognitoIdentityProvider.SetUserSettings
- module Network.AWS.CognitoIdentityProvider.AdminListDevices
- module Network.AWS.CognitoIdentityProvider.DescribeUserPoolClient
- module Network.AWS.CognitoIdentityProvider.ResendConfirmationCode
- module Network.AWS.CognitoIdentityProvider.GetGroup
- module Network.AWS.CognitoIdentityProvider.AdminSetUserSettings
- module Network.AWS.CognitoIdentityProvider.ListDevices
- data AliasAttributeType
- data AttributeDataType
- data AuthFlowType
- data ChallengeNameType
- data DefaultEmailOptionType
- data DeliveryMediumType
- data DeviceRememberedStatusType
- data DomainStatusType
- data ExplicitAuthFlowsType
- data IdentityProviderTypeType
- data MessageActionType
- data OAuthFlowType
- data StatusType
- data UserImportJobStatusType
- data UserPoolMFAType
- data UserStatusType
- data UsernameAttributeType
- data VerifiedAttributeType
- | PhoneNumber
- data AdminCreateUserConfigType
- adminCreateUserConfigType :: AdminCreateUserConfigType
- acuctAllowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool)
- acuctUnusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural)
- acuctInviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType)
- data AttributeType
- attributeType :: Text -> AttributeType
- atValue :: Lens' AttributeType (Maybe Text)
- atName :: Lens' AttributeType 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 CodeDeliveryDetailsType
- codeDeliveryDetailsType :: CodeDeliveryDetailsType
- cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text)
- cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType)
- cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text)
- 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 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 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)
- 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 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 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 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 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 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]
- 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)
- uptEmailVerificationMessage :: Lens' UserPoolType (Maybe Text)
- uptSmsAuthenticationMessage :: Lens' UserPoolType (Maybe Text)
- 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 Source #
API version 2016-04-18
of the Amazon Cognito Identity Provider SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CognitoIdentityProvider
.
UnsupportedUserStateException
_UnsupportedUserStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because the user is in an unsupported state.
PasswordResetRequiredException
_PasswordResetRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a password reset is required.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidLambdaResponseException
_InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
InvalidEmailRoleAccessPolicyException
_InvalidEmailRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
UnsupportedIdentityProviderException
_UnsupportedIdentityProviderException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified identifier is not supported.
UserNotFoundException
_UserNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user is not found.
UnexpectedLambdaException
_UnexpectedLambdaException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
NotAuthorizedException
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user is not authorized.
InternalErrorException
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidUserPoolConfigurationException
_InvalidUserPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the user pool configuration is invalid.
InvalidSmsRoleAccessPolicyException
_InvalidSmsRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
InvalidOAuthFlowException
_InvalidOAuthFlowException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified OAuth flow is invalid.
CodeMismatchException
_CodeMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if the provided code does not match what the server was expecting.
UserImportInProgressException
_UserImportInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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
_InvalidSmsRoleTrustRelationshipException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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
_UserPoolTaggingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user pool tag cannot be set or updated.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the user has made too many requests for a given operation.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if two or more modifications are happening concurrently.
UserLambdaValidationException
_UserLambdaValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
PreconditionNotMetException
_PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a precondition is not met.
ExpiredCodeException
_ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if a code has expired.
TooManyFailedAttemptsException
_TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).
UserNotConfirmedException
_UserNotConfirmedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user is not confirmed successfully.
GroupExistsException
_GroupExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
CodeDeliveryFailureException
_CodeDeliveryFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a verification code fails to deliver successfully.
ScopeDoesNotExistException
_ScopeDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified scope does not exist.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
MFAMethodNotFoundException
_MFAMethodNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.
AliasExistsException
_AliasExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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
_DuplicateProviderException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provider is already supported by the user pool.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user exceeds the limit for a requested AWS resource.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid password.
UsernameExistsException
_UsernameExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteUserPool
UpdateUserPool
DeleteUserPoolDomain
AdminInitiateAuth
AdminLinkProviderForUser
AdminEnableUser
GetUserAttributeVerificationCode
UpdateUserAttributes
DeleteUserAttributes
VerifyUserAttribute
AdminDisableUser
ConfirmDevice
ConfirmForgotPassword
ListUserImportJobs
DescribeIdentityProvider
ListUsers
AdminDeleteUserAttributes
DescribeUserPoolDomain
AdminUpdateUserAttributes
AdminGetUser
AdminUserGlobalSignOut
ListUsersInGroup
AdminDisableProviderForUser
ForgotPassword
DescribeUserPool
InitiateAuth
AdminListGroupsForUser
AdminConfirmSignUp
StartUserImportJob
CreateIdentityProvider
SetUICustomization
ListIdentityProviders
GetDevice
SignUp
DeleteResourceServer
UpdateResourceServer
ChangePassword
CreateUserPoolDomain
RespondToAuthChallenge
CreateUserPool
AdminGetDevice
GetIdentityProviderByIdentifier
AdminRemoveUserFromGroup
ConfirmSignUp
ListUserPools
AdminResetUserPassword
CreateUserImportJob
GetUser
GetUICustomization
GetCSVHeader
AdminDeleteUser
AdminForgetDevice
DescribeResourceServer
AdminUpdateDeviceStatus
AdminCreateUser
AddCustomAttributes
ListUserPoolClients
UpdateUserPoolClient
DeleteUserPoolClient
UpdateDeviceStatus
ForgetDevice
DeleteUser
CreateUserPoolClient
CreateResourceServer
CreateGroup
AdminAddUserToGroup
StopUserImportJob
DescribeUserImportJob
DeleteGroup
UpdateGroup
GlobalSignOut
ListGroups
UpdateIdentityProvider
DeleteIdentityProvider
ListResourceServers
AdminRespondToAuthChallenge
SetUserSettings
AdminListDevices
DescribeUserPoolClient
ResendConfirmationCode
GetGroup
AdminSetUserSettings
ListDevices
Types
AliasAttributeType
data AliasAttributeType Source #
AttributeDataType
data AttributeDataType Source #
AuthFlowType
data AuthFlowType Source #
ChallengeNameType
data ChallengeNameType Source #
CNTAdminNoSrpAuth | |
CNTCustomChallenge | |
CNTDevicePasswordVerifier | |
CNTDeviceSrpAuth | |
CNTNewPasswordRequired | |
CNTPasswordVerifier | |
CNTSmsMFA |
DefaultEmailOptionType
data DefaultEmailOptionType Source #
DeliveryMediumType
data DeliveryMediumType Source #
DeviceRememberedStatusType
data DeviceRememberedStatusType Source #
DomainStatusType
data DomainStatusType Source #
ExplicitAuthFlowsType
data ExplicitAuthFlowsType Source #
IdentityProviderTypeType
data IdentityProviderTypeType Source #
MessageActionType
data MessageActionType Source #
OAuthFlowType
data OAuthFlowType Source #
StatusType
data StatusType Source #
UserImportJobStatusType
data UserImportJobStatusType Source #
UserPoolMFAType
data UserPoolMFAType Source #
UserStatusType
data UserStatusType Source #
UsernameAttributeType
data UsernameAttributeType Source #
VerifiedAttributeType
data VerifiedAttributeType Source #
AdminCreateUserConfigType
data AdminCreateUserConfigType Source #
The type of configuration for creating a new user profile.
See: adminCreateUserConfigType
smart constructor.
adminCreateUserConfigType :: AdminCreateUserConfigType Source #
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 toTrue
if only the administrator is allowed to create user profiles. Set toFalse
if 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 callAdminCreateUser
again, specifyingRESEND
for theMessageAction
parameter. The default value for this parameter is 7.acuctInviteMessageTemplate
- The message template to be used for the welcome message to new users.
acuctAllowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool) Source #
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) Source #
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) Source #
The message template to be used for the welcome message to new users.
AttributeType
data AttributeType Source #
Specifies whether the attribute is standard or custom.
See: attributeType
smart constructor.
:: 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:
AuthenticationResultType
data AuthenticationResultType Source #
The result type of the authentication result.
See: authenticationResultType
smart constructor.
authenticationResultType :: AuthenticationResultType Source #
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 of the authentication result.artRefreshToken
- The refresh token of the authentication result.artNewDeviceMetadata
- The new device metadata from an authentication result.artExpiresIn
- The expiration period of the authentication result.artTokenType
- The token type of the authentication result.artIdToken
- The ID token of the authentication result.
artAccessToken :: Lens' AuthenticationResultType (Maybe Text) Source #
The access token of the authentication result.
artRefreshToken :: Lens' AuthenticationResultType (Maybe Text) Source #
The refresh token of the authentication result.
artNewDeviceMetadata :: Lens' AuthenticationResultType (Maybe NewDeviceMetadataType) Source #
The new device metadata from an authentication result.
artExpiresIn :: Lens' AuthenticationResultType (Maybe Int) Source #
The expiration period of the authentication result.
artTokenType :: Lens' AuthenticationResultType (Maybe Text) Source #
The token type of the authentication result.
artIdToken :: Lens' AuthenticationResultType (Maybe Text) Source #
The ID token of the authentication result.
CodeDeliveryDetailsType
data CodeDeliveryDetailsType Source #
The type of code delivery details being returned from the server.
See: codeDeliveryDetailsType
smart constructor.
codeDeliveryDetailsType :: CodeDeliveryDetailsType Source #
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 name of the attribute in the code delivery details type.
cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text) Source #
The destination for the code delivery details.
cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType) Source #
The delivery medium (email message or phone number).
cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text) Source #
The name of the attribute in the code delivery details type.
DeviceConfigurationType
data DeviceConfigurationType Source #
The type of configuration for the user pool's device tracking.
See: deviceConfigurationType
smart constructor.
deviceConfigurationType :: DeviceConfigurationType Source #
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) Source #
Indicates whether a challenge is required on a new device. Only applicable to a new device.
dctDeviceOnlyRememberedOnUserPrompt :: Lens' DeviceConfigurationType (Maybe Bool) Source #
If true, a device is only remembered on user prompt.
DeviceSecretVerifierConfigType
data DeviceSecretVerifierConfigType Source #
The device verifier against which it will be authenticated.
See: deviceSecretVerifierConfigType
smart constructor.
deviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType Source #
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) Source #
The password verifier.
DeviceType
data DeviceType Source #
The device type.
See: deviceType
smart constructor.
deviceType :: DeviceType Source #
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) Source #
The last modified date of the device.
dtDeviceCreateDate :: Lens' DeviceType (Maybe UTCTime) Source #
The creation date of the device.
dtDeviceAttributes :: Lens' DeviceType [AttributeType] Source #
The device attributes.
dtDeviceKey :: Lens' DeviceType (Maybe Text) Source #
The device key.
dtDeviceLastAuthenticatedDate :: Lens' DeviceType (Maybe UTCTime) Source #
The date in which the device was last authenticated.
DomainDescriptionType
data DomainDescriptionType Source #
A container for information about a domain.
See: domainDescriptionType
smart constructor.
domainDescriptionType :: DomainDescriptionType Source #
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) Source #
The domain status.
ddtCloudFrontDistribution :: Lens' DomainDescriptionType (Maybe Text) Source #
The ARN of the CloudFront distribution.
ddtUserPoolId :: Lens' DomainDescriptionType (Maybe Text) Source #
The user pool ID.
ddtAWSAccountId :: Lens' DomainDescriptionType (Maybe Text) Source #
The AWS account ID for the user pool owner.
ddtVersion :: Lens' DomainDescriptionType (Maybe Text) Source #
The app version.
ddtS3Bucket :: Lens' DomainDescriptionType (Maybe Text) Source #
The S3 bucket where the static files for this domain are stored.
EmailConfigurationType
data EmailConfigurationType Source #
The email configuration type.
See: emailConfigurationType
smart constructor.
emailConfigurationType :: EmailConfigurationType Source #
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 REPLY-TO email address.
ectSourceARN :: Lens' EmailConfigurationType (Maybe Text) Source #
The Amazon Resource Name (ARN) of the email source.
ectReplyToEmailAddress :: Lens' EmailConfigurationType (Maybe Text) Source #
The REPLY-TO email address.
GroupType
The group type.
See: groupType
smart constructor.
groupType :: GroupType Source #
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:roles
andcognito:preferred_role
claims in the user's tokens. Groups with higherPrecedence
values take precedence over groups with lowerPrecedence
values or with nullPrecedence
values. Two groups can have the samePrecedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim is not set in users' tokens. The defaultPrecedence
value 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) Source #
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.
gtDescription :: Lens' GroupType (Maybe Text) Source #
A string containing the description of the group.
IdentityProviderType
data IdentityProviderType Source #
A container for information about an identity provider.
See: identityProviderType
smart constructor.
identityProviderType :: IdentityProviderType Source #
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 asMetadataURL
andMetadataFile
.iptProviderName
- The identity provider name.
iptLastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime) Source #
The date the identity provider was last modified.
iptUserPoolId :: Lens' IdentityProviderType (Maybe Text) Source #
The user pool ID.
iptProviderType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType) Source #
The identity provider type.
iptCreationDate :: Lens' IdentityProviderType (Maybe UTCTime) Source #
The date the identity provider was created.
iptIdpIdentifiers :: Lens' IdentityProviderType [Text] Source #
A list of identity provider identifiers.
iptAttributeMapping :: Lens' IdentityProviderType (HashMap Text Text) Source #
A mapping of identity provider attributes to standard and custom user pool attributes.
iptProviderDetails :: Lens' IdentityProviderType (HashMap Text Text) Source #
The identity provider details, such as MetadataURL
and MetadataFile
.
iptProviderName :: Lens' IdentityProviderType (Maybe Text) Source #
The identity provider name.
LambdaConfigType
data LambdaConfigType Source #
Specifies the type of configuration for AWS Lambda triggers.
See: lambdaConfigType
smart constructor.
lambdaConfigType :: LambdaConfigType Source #
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.lctPreSignUp
- A pre-registration AWS Lambda trigger.
lctPreAuthentication :: Lens' LambdaConfigType (Maybe Text) Source #
A pre-authentication AWS Lambda trigger.
lctCreateAuthChallenge :: Lens' LambdaConfigType (Maybe Text) Source #
Creates an authentication challenge.
lctVerifyAuthChallengeResponse :: Lens' LambdaConfigType (Maybe Text) Source #
Verifies the authentication challenge response.
lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text) Source #
A post-authentication AWS Lambda trigger.
lctCustomMessage :: Lens' LambdaConfigType (Maybe Text) Source #
A custom Message AWS Lambda trigger.
lctDefineAuthChallenge :: Lens' LambdaConfigType (Maybe Text) Source #
Defines the authentication challenge.
lctPostConfirmation :: Lens' LambdaConfigType (Maybe Text) Source #
A post-confirmation AWS Lambda trigger.
lctPreSignUp :: Lens' LambdaConfigType (Maybe Text) Source #
A pre-registration AWS Lambda trigger.
MFAOptionType
data MFAOptionType Source #
Specifies the different settings for multi-factor authentication (MFA).
See: mfaOptionType
smart constructor.
mfaOptionType :: MFAOptionType Source #
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) Source #
The delivery medium (email message or SMS message) to send the MFA code.
motAttributeName :: Lens' MFAOptionType (Maybe Text) Source #
The attribute name of the MFA option type.
MessageTemplateType
data MessageTemplateType Source #
The message template structure.
See: messageTemplateType
smart constructor.
messageTemplateType :: MessageTemplateType Source #
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) Source #
The subject line for email messages.
mttSMSMessage :: Lens' MessageTemplateType (Maybe Text) Source #
The message template for SMS messages.
mttEmailMessage :: Lens' MessageTemplateType (Maybe Text) Source #
The message template for email messages.
NewDeviceMetadataType
data NewDeviceMetadataType Source #
The new device metadata type.
See: newDeviceMetadataType
smart constructor.
newDeviceMetadataType :: NewDeviceMetadataType Source #
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) Source #
The device group key.
ndmtDeviceKey :: Lens' NewDeviceMetadataType (Maybe Text) Source #
The device key.
NumberAttributeConstraintsType
data NumberAttributeConstraintsType Source #
The minimum and maximum value of an attribute that is of the number data type.
See: numberAttributeConstraintsType
smart constructor.
numberAttributeConstraintsType :: NumberAttributeConstraintsType Source #
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) Source #
The maximum value of an attribute that is of the number data type.
nactMinValue :: Lens' NumberAttributeConstraintsType (Maybe Text) Source #
The minimum value of an attribute that is of the number data type.
PasswordPolicyType
data PasswordPolicyType Source #
The password policy type.
See: passwordPolicyType
smart constructor.
passwordPolicyType :: PasswordPolicyType Source #
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) Source #
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) Source #
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) Source #
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) Source #
The minimum length of the password policy that you have set. Cannot be less than 6.
pptRequireSymbols :: Lens' PasswordPolicyType (Maybe Bool) Source #
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 Source #
A container for identity provider details.
See: providerDescription
smart constructor.
providerDescription :: ProviderDescription Source #
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) Source #
The date the provider was last modified.
pdProviderType :: Lens' ProviderDescription (Maybe IdentityProviderTypeType) Source #
The identity provider type.
pdCreationDate :: Lens' ProviderDescription (Maybe UTCTime) Source #
The date the provider was added to the user pool.
pdProviderName :: Lens' ProviderDescription (Maybe Text) Source #
The identity provider name.
ProviderUserIdentifierType
data ProviderUserIdentifierType Source #
A container for information about an identity provider for a user pool.
See: providerUserIdentifierType
smart constructor.
providerUserIdentifierType :: ProviderUserIdentifierType Source #
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) Source #
The value of the provider attribute to link to, for example, xxxxx_account
.
puitProviderAttributeName :: Lens' ProviderUserIdentifierType (Maybe Text) Source #
The name of the provider attribute to link to, for example, NameID
.
puitProviderName :: Lens' ProviderUserIdentifierType (Maybe Text) Source #
The name of the provider, for example, Facebook, Google, or Login with Amazon.
ResourceServerScopeType
data ResourceServerScopeType Source #
A resource server scope.
See: resourceServerScopeType
smart constructor.
resourceServerScopeType Source #
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 Source #
The name of the scope.
rsstScopeDescription :: Lens' ResourceServerScopeType Text Source #
A description of the scope.
ResourceServerType
data ResourceServerType Source #
A container for information about a resource server for a user pool.
See: resourceServerType
smart constructor.
resourceServerType :: ResourceServerType Source #
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) Source #
The user pool ID for the user pool that hosts the resource server.
rstIdentifier :: Lens' ResourceServerType (Maybe Text) Source #
The identifier for the resource server.
rstScopes :: Lens' ResourceServerType [ResourceServerScopeType] Source #
A list of scopes that are defined for the resource server.
SchemaAttributeType
data SchemaAttributeType Source #
Contains information about the schema attribute.
See: schemaAttributeType
smart constructor.
schemaAttributeType :: SchemaAttributeType Source #
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) Source #
Specifies the constraints for an attribute of the number type.
satRequired :: Lens' SchemaAttributeType (Maybe Bool) Source #
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) Source #
The attribute data type.
satStringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType) Source #
Specifies the constraints for an attribute of the string type.
satDeveloperOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool) Source #
Specifies whether the attribute type is developer only.
satMutable :: Lens' SchemaAttributeType (Maybe Bool) Source #
Specifies whether the attribute can be changed once it has been created.
SmsConfigurationType
data SmsConfigurationType Source #
The SMS configuration type.
See: smsConfigurationType
smart constructor.
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) Source #
The external ID.
sctSNSCallerARN :: Lens' SmsConfigurationType Text Source #
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.
StringAttributeConstraintsType
data StringAttributeConstraintsType Source #
The type of constraints associated with an attribute of the string type.
See: stringAttributeConstraintsType
smart constructor.
stringAttributeConstraintsType :: StringAttributeConstraintsType Source #
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 of an attribute value of the string type.sactMinLength
- The minimum length of an attribute value of the string type.
sactMaxLength :: Lens' StringAttributeConstraintsType (Maybe Text) Source #
The maximum length of an attribute value of the string type.
sactMinLength :: Lens' StringAttributeConstraintsType (Maybe Text) Source #
The minimum length of an attribute value of the string type.
UICustomizationType
data UICustomizationType Source #
A container for the UI customization information for a user pool's built-in app UI.
See: uICustomizationType
smart constructor.
uICustomizationType :: UICustomizationType Source #
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) Source #
The client ID for the client app.
uictLastModifiedDate :: Lens' UICustomizationType (Maybe UTCTime) Source #
The last-modified date for the UI customization.
uictUserPoolId :: Lens' UICustomizationType (Maybe Text) Source #
The user pool ID for the user pool.
uictCSSVersion :: Lens' UICustomizationType (Maybe Text) Source #
The CSS version number.
uictImageURL :: Lens' UICustomizationType (Maybe Text) Source #
The logo image for the UI customization.
uictCreationDate :: Lens' UICustomizationType (Maybe UTCTime) Source #
The creation date for the UI customization.
UserImportJobType
data UserImportJobType Source #
The user import job type.
See: userImportJobType
smart constructor.
userImportJobType :: UserImportJobType Source #
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.csv
file.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) Source #
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) Source #
The number of users that were skipped.
uijtUserPoolId :: Lens' UserImportJobType (Maybe Text) Source #
The user pool ID for the user pool that the users are being imported into.
uijtJobName :: Lens' UserImportJobType (Maybe Text) Source #
The job name for the user import job.
uijtPreSignedURL :: Lens' UserImportJobType (Maybe Text) Source #
The pre-signed URL to be used to upload the .csv
file.
uijtFailedUsers :: Lens' UserImportJobType (Maybe Integer) Source #
The number of users that could not be imported.
uijtStartDate :: Lens' UserImportJobType (Maybe UTCTime) Source #
The date when the user import job was started.
uijtCompletionMessage :: Lens' UserImportJobType (Maybe Text) Source #
The message returned when the user import job is completed.
uijtCreationDate :: Lens' UserImportJobType (Maybe UTCTime) Source #
The date the user import job was created.
uijtCompletionDate :: Lens' UserImportJobType (Maybe UTCTime) Source #
The date when the user import job was completed.
uijtCloudWatchLogsRoleARN :: Lens' UserImportJobType (Maybe Text) Source #
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) Source #
The number of users that were successfully imported.
UserPoolClientDescription
data UserPoolClientDescription Source #
The description of the user pool client.
See: userPoolClientDescription
smart constructor.
userPoolClientDescription :: UserPoolClientDescription Source #
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) Source #
The ID of the client associated with the user pool.
upcdUserPoolId :: Lens' UserPoolClientDescription (Maybe Text) Source #
The user pool ID for the user pool where you want to describe the user pool client.
upcdClientName :: Lens' UserPoolClientDescription (Maybe Text) Source #
The client name from the user pool client description.
UserPoolClientType
data UserPoolClientType Source #
Contains information about a user pool client.
See: userPoolClientType
smart constructor.
userPoolClientType :: UserPoolClientType Source #
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 theCallbackURLs
list.upctWriteAttributes
- The writeable attributes.upctCreationDate
- The date the user pool client was created.upctReadAttributes
- The Read-only attributes.upctAllowedOAuthScopes
- A list of allowedOAuth
scopes. Currently supported values are"phone"
,"email"
,"openid"
, andCognito
.upctAllowedOAuthFlows
- Set tocode
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 totoken
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.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) Source #
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
upctClientId :: Lens' UserPoolClientType (Maybe Text) Source #
The ID of the client associated with the user pool.
upctExplicitAuthFlows :: Lens' UserPoolClientType [ExplicitAuthFlowsType] Source #
The explicit authentication flows.
upctClientSecret :: Lens' UserPoolClientType (Maybe Text) Source #
The client secret from the user pool request of the client type.
upctLastModifiedDate :: Lens' UserPoolClientType (Maybe UTCTime) Source #
The date the user pool client was last modified.
upctSupportedIdentityProviders :: Lens' UserPoolClientType [Text] Source #
A list of provider names for the identity providers that are supported on this client.
upctLogoutURLs :: Lens' UserPoolClientType [Text] Source #
A list of allowed logout URLs for the identity providers.
upctAllowedOAuthFlowsUserPoolClient :: Lens' UserPoolClientType (Maybe Bool) Source #
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
upctUserPoolId :: Lens' UserPoolClientType (Maybe Text) Source #
The user pool ID for the user pool client.
upctDefaultRedirectURI :: Lens' UserPoolClientType (Maybe Text) Source #
The default redirect URI. Must be in the CallbackURLs
list.
upctWriteAttributes :: Lens' UserPoolClientType [Text] Source #
The writeable attributes.
upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime) Source #
The date the user pool client was created.
upctReadAttributes :: Lens' UserPoolClientType [Text] Source #
The Read-only attributes.
upctAllowedOAuthScopes :: Lens' UserPoolClientType [Text] Source #
A list of allowed OAuth
scopes. Currently supported values are "phone"
, "email"
, "openid"
, and Cognito
.
upctAllowedOAuthFlows :: Lens' UserPoolClientType [OAuthFlowType] Source #
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.
upctClientName :: Lens' UserPoolClientType (Maybe Text) Source #
The client name from the user pool request of the client type.
upctCallbackURLs :: Lens' UserPoolClientType [Text] Source #
A list of allowed callback URLs for the identity providers.
UserPoolDescriptionType
data UserPoolDescriptionType Source #
A user pool description.
See: userPoolDescriptionType
smart constructor.
userPoolDescriptionType :: UserPoolDescriptionType Source #
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) Source #
The user pool status in a user pool description.
updtLastModifiedDate :: Lens' UserPoolDescriptionType (Maybe UTCTime) Source #
The date the user pool description was last modified.
updtCreationDate :: Lens' UserPoolDescriptionType (Maybe UTCTime) Source #
The date the user pool description was created.
updtLambdaConfig :: Lens' UserPoolDescriptionType (Maybe LambdaConfigType) Source #
The AWS Lambda configuration information in a user pool description.
UserPoolPolicyType
data UserPoolPolicyType Source #
The type of policy in a user pool.
See: userPoolPolicyType
smart constructor.
userPoolPolicyType :: UserPoolPolicyType Source #
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
- A container for information about the user pool password policy.
upptPasswordPolicy :: Lens' UserPoolPolicyType (Maybe PasswordPolicyType) Source #
A container for information about the user pool password policy.
UserPoolType
data UserPoolType Source #
A container for information about the user pool type.
See: userPoolType
smart constructor.
userPoolType :: UserPoolType Source #
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.uptEmailVerificationMessage
- The contents of the email verification message.uptSmsAuthenticationMessage
- The contents of the SMS authentication message.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
- A container for the AWS Lambda triggers associated with a user pool.uptSmsConfiguration
- The SMS configuration.uptAdminCreateUserConfig
- The configuration forAdminCreateUser
requests.uptDeviceConfiguration
- The device configuration.uptAutoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.uptPolicies
- A container for the policies associated with a user pool.
uptStatus :: Lens' UserPoolType (Maybe StatusType) Source #
The status of a user pool.
uptUserPoolTags :: Lens' UserPoolType (HashMap Text Text) Source #
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) Source #
The reason why the email configuration cannot send the messages to your users.
uptLastModifiedDate :: Lens' UserPoolType (Maybe UTCTime) Source #
The date the user pool was last modified.
uptVerificationMessageTemplate :: Lens' UserPoolType (Maybe VerificationMessageTemplateType) Source #
The template for verification messages.
uptEstimatedNumberOfUsers :: Lens' UserPoolType (Maybe Int) Source #
A number estimating the size of the user pool.
uptEmailVerificationMessage :: Lens' UserPoolType (Maybe Text) Source #
The contents of the email verification message.
uptSmsAuthenticationMessage :: Lens' UserPoolType (Maybe Text) Source #
The contents of the SMS authentication message.
uptSchemaAttributes :: Lens' UserPoolType (Maybe (NonEmpty SchemaAttributeType)) Source #
A container with the schema attributes of a user pool.
uptEmailVerificationSubject :: Lens' UserPoolType (Maybe Text) Source #
The subject of the email verification message.
uptUsernameAttributes :: Lens' UserPoolType [UsernameAttributeType] Source #
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
uptAliasAttributes :: Lens' UserPoolType [AliasAttributeType] Source #
Specifies the attributes that are aliased in a user pool.
uptEmailConfiguration :: Lens' UserPoolType (Maybe EmailConfigurationType) Source #
The email configuration.
uptSmsVerificationMessage :: Lens' UserPoolType (Maybe Text) Source #
The contents of the SMS verification message.
uptMFAConfiguration :: Lens' UserPoolType (Maybe UserPoolMFAType) Source #
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) Source #
The reason why the SMS configuration cannot send the messages to your users.
uptCreationDate :: Lens' UserPoolType (Maybe UTCTime) Source #
The date the user pool was created.
uptLambdaConfig :: Lens' UserPoolType (Maybe LambdaConfigType) Source #
A container for the AWS Lambda triggers associated with a user pool.
uptSmsConfiguration :: Lens' UserPoolType (Maybe SmsConfigurationType) Source #
The SMS configuration.
uptAdminCreateUserConfig :: Lens' UserPoolType (Maybe AdminCreateUserConfigType) Source #
The configuration for AdminCreateUser
requests.
uptDeviceConfiguration :: Lens' UserPoolType (Maybe DeviceConfigurationType) Source #
The device configuration.
uptAutoVerifiedAttributes :: Lens' UserPoolType [VerifiedAttributeType] Source #
Specifies the attributes that are auto-verified in a user pool.
uptPolicies :: Lens' UserPoolType (Maybe UserPoolPolicyType) Source #
A container for the policies associated with a user pool.
UserType
The user type.
See: userType
smart constructor.
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) Source #
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] Source #
A container with information about the user type attributes.
utMFAOptions :: Lens' UserType [MFAOptionType] Source #
The MFA options for the user.
utUserLastModifiedDate :: Lens' UserType (Maybe UTCTime) Source #
The last modified date of the user.
VerificationMessageTemplateType
data VerificationMessageTemplateType Source #
The template for verification messages.
See: verificationMessageTemplateType
smart constructor.
verificationMessageTemplateType :: VerificationMessageTemplateType Source #
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) Source #
The default email option.
vmttEmailSubject :: Lens' VerificationMessageTemplateType (Maybe Text) Source #
The subject line for the email message template.
vmttEmailSubjectByLink :: Lens' VerificationMessageTemplateType (Maybe Text) Source #
The subject line for the email message template for sending a confirmation link to the user.
vmttSmsMessage :: Lens' VerificationMessageTemplateType (Maybe Text) Source #
The SMS message template.
vmttEmailMessageByLink :: Lens' VerificationMessageTemplateType (Maybe Text) Source #
The email message template for sending a confirmation link to the user.
vmttEmailMessage :: Lens' VerificationMessageTemplateType (Maybe Text) Source #
The email message template.