| Copyright | (c) 2013-2021 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 |
Amazonka.CognitoIdentityProvider
Contents
- Service Configuration
- Errors
- UnsupportedUserStateException
- PasswordResetRequiredException
- InvalidParameterException
- UnsupportedOperationException
- InvalidLambdaResponseException
- InvalidEmailRoleAccessPolicyException
- UnsupportedIdentityProviderException
- UserNotFoundException
- UnexpectedLambdaException
- NotAuthorizedException
- InternalErrorException
- InvalidUserPoolConfigurationException
- InvalidSmsRoleAccessPolicyException
- InvalidOAuthFlowException
- CodeMismatchException
- UserImportInProgressException
- InvalidSmsRoleTrustRelationshipException
- UserPoolTaggingException
- SoftwareTokenMFANotFoundException
- TooManyRequestsException
- ConcurrentModificationException
- UserPoolAddOnNotEnabledException
- UserLambdaValidationException
- PreconditionNotMetException
- ExpiredCodeException
- TooManyFailedAttemptsException
- EnableSoftwareTokenMFAException
- UserNotConfirmedException
- GroupExistsException
- UnauthorizedException
- CodeDeliveryFailureException
- ScopeDoesNotExistException
- ResourceNotFoundException
- MFAMethodNotFoundException
- AliasExistsException
- UnsupportedTokenTypeException
- DuplicateProviderException
- LimitExceededException
- InvalidPasswordException
- UsernameExistsException
- Waiters
- Operations
- DeleteUserPool
- UpdateUserPool
- UpdateUserPoolDomain
- DeleteUserPoolDomain
- AdminInitiateAuth
- AdminLinkProviderForUser
- AdminEnableUser
- GetUserAttributeVerificationCode
- SetUserPoolMfaConfig
- UpdateUserAttributes
- DeleteUserAttributes
- VerifyUserAttribute
- AdminDisableUser
- ConfirmDevice
- ConfirmForgotPassword
- ListUserImportJobs
- ListTagsForResource
- DescribeIdentityProvider
- ListUsers (Paginated)
- AdminDeleteUserAttributes
- DescribeUserPoolDomain
- AdminUpdateUserAttributes
- AdminGetUser
- AdminUserGlobalSignOut
- ListUsersInGroup (Paginated)
- AssociateSoftwareToken
- AdminDisableProviderForUser
- ForgotPassword
- DescribeUserPool
- InitiateAuth
- AdminListGroupsForUser (Paginated)
- AdminConfirmSignUp
- AdminUpdateAuthEventFeedback
- AdminSetUserPassword
- StartUserImportJob
- CreateIdentityProvider
- SetUICustomization
- ListIdentityProviders (Paginated)
- GetDevice
- SignUp
- DeleteResourceServer
- UpdateResourceServer
- ChangePassword
- CreateUserPoolDomain
- RespondToAuthChallenge
- CreateUserPool
- AdminGetDevice
- GetIdentityProviderByIdentifier
- AdminRemoveUserFromGroup
- SetRiskConfiguration
- ConfirmSignUp
- ListUserPools (Paginated)
- AdminResetUserPassword
- UpdateAuthEventFeedback
- CreateUserImportJob
- GetUser
- GetUICustomization
- GetCSVHeader
- AdminDeleteUser
- AdminForgetDevice
- DescribeResourceServer
- SetUserMFAPreference
- AdminUpdateDeviceStatus
- AdminCreateUser
- AddCustomAttributes
- ListUserPoolClients (Paginated)
- AdminSetUserMFAPreference
- UpdateUserPoolClient
- DeleteUserPoolClient
- UpdateDeviceStatus
- ForgetDevice
- GetSigningCertificate
- DeleteUser
- TagResource
- CreateUserPoolClient
- GetUserPoolMfaConfig
- CreateResourceServer
- AdminListUserAuthEvents (Paginated)
- CreateGroup
- AdminAddUserToGroup
- VerifySoftwareToken
- UntagResource
- RevokeToken
- StopUserImportJob
- DescribeUserImportJob
- DescribeRiskConfiguration
- DeleteGroup
- UpdateGroup
- GlobalSignOut
- ListGroups (Paginated)
- UpdateIdentityProvider
- DeleteIdentityProvider
- ListResourceServers (Paginated)
- AdminRespondToAuthChallenge
- SetUserSettings
- AdminListDevices
- DescribeUserPoolClient
- ResendConfirmationCode
- GetGroup
- AdminSetUserSettings
- ListDevices
- Types
- AccountTakeoverEventActionType
- AdvancedSecurityModeType
- AliasAttributeType
- AttributeDataType
- AuthFlowType
- ChallengeName
- ChallengeNameType
- ChallengeResponse
- CompromisedCredentialsEventActionType
- CustomEmailSenderLambdaVersionType
- CustomSMSSenderLambdaVersionType
- DefaultEmailOptionType
- DeliveryMediumType
- DeviceRememberedStatusType
- DomainStatusType
- EmailSendingAccountType
- EventFilterType
- EventResponseType
- EventType
- ExplicitAuthFlowsType
- FeedbackValueType
- IdentityProviderTypeType
- MessageActionType
- OAuthFlowType
- PreventUserExistenceErrorTypes
- RecoveryOptionNameType
- RiskDecisionType
- RiskLevelType
- StatusType
- TimeUnitsType
- UserImportJobStatusType
- UserPoolMfaType
- UserStatusType
- UsernameAttributeType
- VerifiedAttributeType
- VerifySoftwareTokenResponseType
- AccountRecoverySettingType
- AccountTakeoverActionType
- AccountTakeoverActionsType
- AccountTakeoverRiskConfigurationType
- AdminCreateUserConfigType
- AnalyticsConfigurationType
- AnalyticsMetadataType
- AttributeType
- AuthEventType
- AuthenticationResultType
- ChallengeResponseType
- CodeDeliveryDetailsType
- CompromisedCredentialsActionsType
- CompromisedCredentialsRiskConfigurationType
- ContextDataType
- CustomDomainConfigType
- CustomEmailLambdaVersionConfigType
- CustomSMSLambdaVersionConfigType
- DeviceConfigurationType
- DeviceSecretVerifierConfigType
- DeviceType
- DomainDescriptionType
- EmailConfigurationType
- EventContextDataType
- EventFeedbackType
- EventRiskType
- GroupType
- HttpHeader
- IdentityProviderType
- LambdaConfigType
- MFAOptionType
- MessageTemplateType
- NewDeviceMetadataType
- NotifyConfigurationType
- NotifyEmailType
- NumberAttributeConstraintsType
- PasswordPolicyType
- ProviderDescription
- ProviderUserIdentifierType
- RecoveryOptionType
- ResourceServerScopeType
- ResourceServerType
- RiskConfigurationType
- RiskExceptionConfigurationType
- SMSMfaSettingsType
- SchemaAttributeType
- SmsConfigurationType
- SmsMfaConfigType
- SoftwareTokenMfaConfigType
- SoftwareTokenMfaSettingsType
- StringAttributeConstraintsType
- TokenValidityUnitsType
- UICustomizationType
- UserContextDataType
- UserImportJobType
- UserPoolAddOnsType
- UserPoolClientDescription
- UserPoolClientType
- UserPoolDescriptionType
- UserPoolPolicyType
- UserPoolType
- UserType
- UsernameConfigurationType
- VerificationMessageTemplateType
Description
Derived from API version 2016-04-18 of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: 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
- _UnsupportedOperationException :: 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
- _UnauthorizedException :: 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
- _UnsupportedTokenTypeException :: 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 DeleteUserPool = DeleteUserPool' Text
- newDeleteUserPool :: Text -> DeleteUserPool
- data DeleteUserPoolResponse = DeleteUserPoolResponse' {
- newDeleteUserPoolResponse :: DeleteUserPoolResponse
- data UpdateUserPool = UpdateUserPool' (Maybe (HashMap Text Text)) (Maybe VerificationMessageTemplateType) (Maybe Text) (Maybe Text) (Maybe UserPoolAddOnsType) (Maybe Text) (Maybe AccountRecoverySettingType) (Maybe EmailConfigurationType) (Maybe Text) (Maybe UserPoolMfaType) (Maybe LambdaConfigType) (Maybe SmsConfigurationType) (Maybe AdminCreateUserConfigType) (Maybe DeviceConfigurationType) (Maybe [VerifiedAttributeType]) (Maybe UserPoolPolicyType) Text
- newUpdateUserPool :: Text -> UpdateUserPool
- data UpdateUserPoolResponse = UpdateUserPoolResponse' Int
- newUpdateUserPoolResponse :: Int -> UpdateUserPoolResponse
- data UpdateUserPoolDomain = UpdateUserPoolDomain' Text Text CustomDomainConfigType
- newUpdateUserPoolDomain :: Text -> Text -> CustomDomainConfigType -> UpdateUserPoolDomain
- data UpdateUserPoolDomainResponse = UpdateUserPoolDomainResponse' (Maybe Text) Int
- newUpdateUserPoolDomainResponse :: Int -> UpdateUserPoolDomainResponse
- data DeleteUserPoolDomain = DeleteUserPoolDomain' Text Text
- newDeleteUserPoolDomain :: Text -> Text -> DeleteUserPoolDomain
- data DeleteUserPoolDomainResponse = DeleteUserPoolDomainResponse' Int
- newDeleteUserPoolDomainResponse :: Int -> DeleteUserPoolDomainResponse
- data AdminInitiateAuth = AdminInitiateAuth' (Maybe (HashMap Text Text)) (Maybe ContextDataType) (Maybe AnalyticsMetadataType) (Maybe (Sensitive (HashMap Text Text))) Text (Sensitive Text) AuthFlowType
- newAdminInitiateAuth :: Text -> Text -> AuthFlowType -> AdminInitiateAuth
- data AdminInitiateAuthResponse = AdminInitiateAuthResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int
- newAdminInitiateAuthResponse :: Int -> AdminInitiateAuthResponse
- data AdminLinkProviderForUser = AdminLinkProviderForUser' Text ProviderUserIdentifierType ProviderUserIdentifierType
- newAdminLinkProviderForUser :: Text -> ProviderUserIdentifierType -> ProviderUserIdentifierType -> AdminLinkProviderForUser
- data AdminLinkProviderForUserResponse = AdminLinkProviderForUserResponse' Int
- newAdminLinkProviderForUserResponse :: Int -> AdminLinkProviderForUserResponse
- data AdminEnableUser = AdminEnableUser' Text (Sensitive Text)
- newAdminEnableUser :: Text -> Text -> AdminEnableUser
- data AdminEnableUserResponse = AdminEnableUserResponse' Int
- newAdminEnableUserResponse :: Int -> AdminEnableUserResponse
- data GetUserAttributeVerificationCode = GetUserAttributeVerificationCode' (Maybe (HashMap Text Text)) (Sensitive Text) Text
- newGetUserAttributeVerificationCode :: Text -> Text -> GetUserAttributeVerificationCode
- data GetUserAttributeVerificationCodeResponse = GetUserAttributeVerificationCodeResponse' (Maybe CodeDeliveryDetailsType) Int
- newGetUserAttributeVerificationCodeResponse :: Int -> GetUserAttributeVerificationCodeResponse
- data SetUserPoolMfaConfig = SetUserPoolMfaConfig' (Maybe SmsMfaConfigType) (Maybe SoftwareTokenMfaConfigType) (Maybe UserPoolMfaType) Text
- newSetUserPoolMfaConfig :: Text -> SetUserPoolMfaConfig
- data SetUserPoolMfaConfigResponse = SetUserPoolMfaConfigResponse' (Maybe SmsMfaConfigType) (Maybe SoftwareTokenMfaConfigType) (Maybe UserPoolMfaType) Int
- newSetUserPoolMfaConfigResponse :: Int -> SetUserPoolMfaConfigResponse
- data UpdateUserAttributes = UpdateUserAttributes' (Maybe (HashMap Text Text)) [AttributeType] (Sensitive Text)
- newUpdateUserAttributes :: Text -> UpdateUserAttributes
- data UpdateUserAttributesResponse = UpdateUserAttributesResponse' (Maybe [CodeDeliveryDetailsType]) Int
- newUpdateUserAttributesResponse :: Int -> UpdateUserAttributesResponse
- data DeleteUserAttributes = DeleteUserAttributes' [Text] (Sensitive Text)
- newDeleteUserAttributes :: Text -> DeleteUserAttributes
- data DeleteUserAttributesResponse = DeleteUserAttributesResponse' Int
- newDeleteUserAttributesResponse :: Int -> DeleteUserAttributesResponse
- data VerifyUserAttribute = VerifyUserAttribute' (Sensitive Text) Text Text
- newVerifyUserAttribute :: Text -> Text -> Text -> VerifyUserAttribute
- data VerifyUserAttributeResponse = VerifyUserAttributeResponse' Int
- newVerifyUserAttributeResponse :: Int -> VerifyUserAttributeResponse
- data AdminDisableUser = AdminDisableUser' Text (Sensitive Text)
- newAdminDisableUser :: Text -> Text -> AdminDisableUser
- data AdminDisableUserResponse = AdminDisableUserResponse' Int
- newAdminDisableUserResponse :: Int -> AdminDisableUserResponse
- data ConfirmDevice = ConfirmDevice' (Maybe DeviceSecretVerifierConfigType) (Maybe Text) (Sensitive Text) Text
- newConfirmDevice :: Text -> Text -> ConfirmDevice
- data ConfirmDeviceResponse = ConfirmDeviceResponse' (Maybe Bool) Int
- newConfirmDeviceResponse :: Int -> ConfirmDeviceResponse
- data ConfirmForgotPassword = ConfirmForgotPassword' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text) Text (Sensitive Text)
- newConfirmForgotPassword :: Text -> Text -> Text -> Text -> ConfirmForgotPassword
- data ConfirmForgotPasswordResponse = ConfirmForgotPasswordResponse' Int
- newConfirmForgotPasswordResponse :: Int -> ConfirmForgotPasswordResponse
- data ListUserImportJobs = ListUserImportJobs' (Maybe Text) Text Natural
- newListUserImportJobs :: Text -> Natural -> ListUserImportJobs
- data ListUserImportJobsResponse = ListUserImportJobsResponse' (Maybe Text) (Maybe (NonEmpty UserImportJobType)) Int
- newListUserImportJobsResponse :: Int -> ListUserImportJobsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribeIdentityProvider = DescribeIdentityProvider' Text Text
- newDescribeIdentityProvider :: Text -> Text -> DescribeIdentityProvider
- data DescribeIdentityProviderResponse = DescribeIdentityProviderResponse' Int IdentityProviderType
- newDescribeIdentityProviderResponse :: Int -> IdentityProviderType -> DescribeIdentityProviderResponse
- data ListUsers = ListUsers' (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Text) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) (Maybe [UserType]) Int
- newListUsersResponse :: Int -> ListUsersResponse
- data AdminDeleteUserAttributes = AdminDeleteUserAttributes' Text (Sensitive Text) [Text]
- newAdminDeleteUserAttributes :: Text -> Text -> AdminDeleteUserAttributes
- data AdminDeleteUserAttributesResponse = AdminDeleteUserAttributesResponse' Int
- newAdminDeleteUserAttributesResponse :: Int -> AdminDeleteUserAttributesResponse
- data DescribeUserPoolDomain = DescribeUserPoolDomain' Text
- newDescribeUserPoolDomain :: Text -> DescribeUserPoolDomain
- data DescribeUserPoolDomainResponse = DescribeUserPoolDomainResponse' (Maybe DomainDescriptionType) Int
- newDescribeUserPoolDomainResponse :: Int -> DescribeUserPoolDomainResponse
- data AdminUpdateUserAttributes = AdminUpdateUserAttributes' (Maybe (HashMap Text Text)) Text (Sensitive Text) [AttributeType]
- newAdminUpdateUserAttributes :: Text -> Text -> AdminUpdateUserAttributes
- data AdminUpdateUserAttributesResponse = AdminUpdateUserAttributesResponse' Int
- newAdminUpdateUserAttributesResponse :: Int -> AdminUpdateUserAttributesResponse
- data AdminGetUser = AdminGetUser' Text (Sensitive Text)
- newAdminGetUser :: Text -> Text -> AdminGetUser
- data AdminGetUserResponse = AdminGetUserResponse' (Maybe Bool) (Maybe UserStatusType) (Maybe [AttributeType]) (Maybe POSIX) (Maybe [Text]) (Maybe [MFAOptionType]) (Maybe POSIX) (Maybe Text) Int (Sensitive Text)
- newAdminGetUserResponse :: Int -> Text -> AdminGetUserResponse
- data AdminUserGlobalSignOut = AdminUserGlobalSignOut' Text (Sensitive Text)
- newAdminUserGlobalSignOut :: Text -> Text -> AdminUserGlobalSignOut
- data AdminUserGlobalSignOutResponse = AdminUserGlobalSignOutResponse' Int
- newAdminUserGlobalSignOutResponse :: Int -> AdminUserGlobalSignOutResponse
- data ListUsersInGroup = ListUsersInGroup' (Maybe Text) (Maybe Natural) Text Text
- newListUsersInGroup :: Text -> Text -> ListUsersInGroup
- data ListUsersInGroupResponse = ListUsersInGroupResponse' (Maybe [UserType]) (Maybe Text) Int
- newListUsersInGroupResponse :: Int -> ListUsersInGroupResponse
- data AssociateSoftwareToken = AssociateSoftwareToken' (Maybe (Sensitive Text)) (Maybe Text)
- newAssociateSoftwareToken :: AssociateSoftwareToken
- data AssociateSoftwareTokenResponse = AssociateSoftwareTokenResponse' (Maybe (Sensitive Text)) (Maybe Text) Int
- newAssociateSoftwareTokenResponse :: Int -> AssociateSoftwareTokenResponse
- data AdminDisableProviderForUser = AdminDisableProviderForUser' Text ProviderUserIdentifierType
- newAdminDisableProviderForUser :: Text -> ProviderUserIdentifierType -> AdminDisableProviderForUser
- data AdminDisableProviderForUserResponse = AdminDisableProviderForUserResponse' Int
- newAdminDisableProviderForUserResponse :: Int -> AdminDisableProviderForUserResponse
- data ForgotPassword = ForgotPassword' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text)
- newForgotPassword :: Text -> Text -> ForgotPassword
- data ForgotPasswordResponse = ForgotPasswordResponse' (Maybe CodeDeliveryDetailsType) Int
- newForgotPasswordResponse :: Int -> ForgotPasswordResponse
- data DescribeUserPool = DescribeUserPool' Text
- newDescribeUserPool :: Text -> DescribeUserPool
- data DescribeUserPoolResponse = DescribeUserPoolResponse' (Maybe UserPoolType) Int
- newDescribeUserPoolResponse :: Int -> DescribeUserPoolResponse
- data InitiateAuth = InitiateAuth' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive (HashMap Text Text))) AuthFlowType (Sensitive Text)
- newInitiateAuth :: AuthFlowType -> Text -> InitiateAuth
- data InitiateAuthResponse = InitiateAuthResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int
- newInitiateAuthResponse :: Int -> InitiateAuthResponse
- data AdminListGroupsForUser = AdminListGroupsForUser' (Maybe Text) (Maybe Natural) (Sensitive Text) Text
- newAdminListGroupsForUser :: Text -> Text -> AdminListGroupsForUser
- data AdminListGroupsForUserResponse = AdminListGroupsForUserResponse' (Maybe [GroupType]) (Maybe Text) Int
- newAdminListGroupsForUserResponse :: Int -> AdminListGroupsForUserResponse
- data AdminConfirmSignUp = AdminConfirmSignUp' (Maybe (HashMap Text Text)) Text (Sensitive Text)
- newAdminConfirmSignUp :: Text -> Text -> AdminConfirmSignUp
- data AdminConfirmSignUpResponse = AdminConfirmSignUpResponse' Int
- newAdminConfirmSignUpResponse :: Int -> AdminConfirmSignUpResponse
- data AdminUpdateAuthEventFeedback = AdminUpdateAuthEventFeedback' Text (Sensitive Text) Text FeedbackValueType
- newAdminUpdateAuthEventFeedback :: Text -> Text -> Text -> FeedbackValueType -> AdminUpdateAuthEventFeedback
- data AdminUpdateAuthEventFeedbackResponse = AdminUpdateAuthEventFeedbackResponse' Int
- newAdminUpdateAuthEventFeedbackResponse :: Int -> AdminUpdateAuthEventFeedbackResponse
- data AdminSetUserPassword = AdminSetUserPassword' (Maybe Bool) Text (Sensitive Text) (Sensitive Text)
- newAdminSetUserPassword :: Text -> Text -> Text -> AdminSetUserPassword
- data AdminSetUserPasswordResponse = AdminSetUserPasswordResponse' Int
- newAdminSetUserPasswordResponse :: Int -> AdminSetUserPasswordResponse
- data StartUserImportJob = StartUserImportJob' Text Text
- newStartUserImportJob :: Text -> Text -> StartUserImportJob
- data StartUserImportJobResponse = StartUserImportJobResponse' (Maybe UserImportJobType) Int
- newStartUserImportJobResponse :: Int -> StartUserImportJobResponse
- data CreateIdentityProvider = CreateIdentityProvider' (Maybe [Text]) (Maybe (HashMap Text Text)) Text Text IdentityProviderTypeType (HashMap Text Text)
- newCreateIdentityProvider :: Text -> Text -> IdentityProviderTypeType -> CreateIdentityProvider
- data CreateIdentityProviderResponse = CreateIdentityProviderResponse' Int IdentityProviderType
- newCreateIdentityProviderResponse :: Int -> IdentityProviderType -> CreateIdentityProviderResponse
- data SetUICustomization = SetUICustomization' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Base64) Text
- newSetUICustomization :: Text -> SetUICustomization
- data SetUICustomizationResponse = SetUICustomizationResponse' Int UICustomizationType
- newSetUICustomizationResponse :: Int -> UICustomizationType -> SetUICustomizationResponse
- data ListIdentityProviders = ListIdentityProviders' (Maybe Text) (Maybe Natural) Text
- newListIdentityProviders :: Text -> ListIdentityProviders
- data ListIdentityProvidersResponse = ListIdentityProvidersResponse' (Maybe Text) Int [ProviderDescription]
- newListIdentityProvidersResponse :: Int -> ListIdentityProvidersResponse
- data GetDevice = GetDevice' (Maybe (Sensitive Text)) Text
- newGetDevice :: Text -> GetDevice
- data GetDeviceResponse = GetDeviceResponse' Int DeviceType
- newGetDeviceResponse :: Int -> DeviceType -> GetDeviceResponse
- data SignUp = SignUp' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe [AttributeType]) (Maybe (Sensitive Text)) (Maybe [AttributeType]) (Sensitive Text) (Sensitive Text) (Sensitive Text)
- newSignUp :: Text -> Text -> Text -> SignUp
- data SignUpResponse = SignUpResponse' (Maybe CodeDeliveryDetailsType) Int Bool Text
- newSignUpResponse :: Int -> Bool -> Text -> SignUpResponse
- data DeleteResourceServer = DeleteResourceServer' Text Text
- newDeleteResourceServer :: Text -> Text -> DeleteResourceServer
- data DeleteResourceServerResponse = DeleteResourceServerResponse' {
- newDeleteResourceServerResponse :: DeleteResourceServerResponse
- data UpdateResourceServer = UpdateResourceServer' (Maybe [ResourceServerScopeType]) Text Text Text
- newUpdateResourceServer :: Text -> Text -> Text -> UpdateResourceServer
- data UpdateResourceServerResponse = UpdateResourceServerResponse' Int ResourceServerType
- newUpdateResourceServerResponse :: Int -> ResourceServerType -> UpdateResourceServerResponse
- data ChangePassword = ChangePassword' (Sensitive Text) (Sensitive Text) (Sensitive Text)
- newChangePassword :: Text -> Text -> Text -> ChangePassword
- data ChangePasswordResponse = ChangePasswordResponse' Int
- newChangePasswordResponse :: Int -> ChangePasswordResponse
- data CreateUserPoolDomain = CreateUserPoolDomain' (Maybe CustomDomainConfigType) Text Text
- newCreateUserPoolDomain :: Text -> Text -> CreateUserPoolDomain
- data CreateUserPoolDomainResponse = CreateUserPoolDomainResponse' (Maybe Text) Int
- newCreateUserPoolDomainResponse :: Int -> CreateUserPoolDomainResponse
- data RespondToAuthChallenge = RespondToAuthChallenge' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe (HashMap Text Text)) (Maybe UserContextDataType) (Maybe Text) (Sensitive Text) ChallengeNameType
- newRespondToAuthChallenge :: Text -> ChallengeNameType -> RespondToAuthChallenge
- data RespondToAuthChallengeResponse = RespondToAuthChallengeResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int
- newRespondToAuthChallengeResponse :: Int -> RespondToAuthChallengeResponse
- data CreateUserPool = CreateUserPool' (Maybe (HashMap Text Text)) (Maybe VerificationMessageTemplateType) (Maybe Text) (Maybe Text) (Maybe UserPoolAddOnsType) (Maybe Text) (Maybe [UsernameAttributeType]) (Maybe [AliasAttributeType]) (Maybe (NonEmpty SchemaAttributeType)) (Maybe AccountRecoverySettingType) (Maybe EmailConfigurationType) (Maybe Text) (Maybe UserPoolMfaType) (Maybe LambdaConfigType) (Maybe SmsConfigurationType) (Maybe AdminCreateUserConfigType) (Maybe DeviceConfigurationType) (Maybe [VerifiedAttributeType]) (Maybe UserPoolPolicyType) (Maybe UsernameConfigurationType) Text
- newCreateUserPool :: Text -> CreateUserPool
- data CreateUserPoolResponse = CreateUserPoolResponse' (Maybe UserPoolType) Int
- newCreateUserPoolResponse :: Int -> CreateUserPoolResponse
- data AdminGetDevice = AdminGetDevice' Text Text (Sensitive Text)
- newAdminGetDevice :: Text -> Text -> Text -> AdminGetDevice
- data AdminGetDeviceResponse = AdminGetDeviceResponse' Int DeviceType
- newAdminGetDeviceResponse :: Int -> DeviceType -> AdminGetDeviceResponse
- data GetIdentityProviderByIdentifier = GetIdentityProviderByIdentifier' Text Text
- newGetIdentityProviderByIdentifier :: Text -> Text -> GetIdentityProviderByIdentifier
- data GetIdentityProviderByIdentifierResponse = GetIdentityProviderByIdentifierResponse' Int IdentityProviderType
- newGetIdentityProviderByIdentifierResponse :: Int -> IdentityProviderType -> GetIdentityProviderByIdentifierResponse
- data AdminRemoveUserFromGroup = AdminRemoveUserFromGroup' Text (Sensitive Text) Text
- newAdminRemoveUserFromGroup :: Text -> Text -> Text -> AdminRemoveUserFromGroup
- data AdminRemoveUserFromGroupResponse = AdminRemoveUserFromGroupResponse' {
- newAdminRemoveUserFromGroupResponse :: AdminRemoveUserFromGroupResponse
- data SetRiskConfiguration = SetRiskConfiguration' (Maybe RiskExceptionConfigurationType) (Maybe (Sensitive Text)) (Maybe AccountTakeoverRiskConfigurationType) (Maybe CompromisedCredentialsRiskConfigurationType) Text
- newSetRiskConfiguration :: Text -> SetRiskConfiguration
- data SetRiskConfigurationResponse = SetRiskConfigurationResponse' Int RiskConfigurationType
- newSetRiskConfigurationResponse :: Int -> RiskConfigurationType -> SetRiskConfigurationResponse
- data ConfirmSignUp = ConfirmSignUp' (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text) Text
- newConfirmSignUp :: Text -> Text -> Text -> ConfirmSignUp
- data ConfirmSignUpResponse = ConfirmSignUpResponse' Int
- newConfirmSignUpResponse :: Int -> ConfirmSignUpResponse
- data ListUserPools = ListUserPools' (Maybe Text) Natural
- newListUserPools :: Natural -> ListUserPools
- data ListUserPoolsResponse = ListUserPoolsResponse' (Maybe [UserPoolDescriptionType]) (Maybe Text) Int
- newListUserPoolsResponse :: Int -> ListUserPoolsResponse
- data AdminResetUserPassword = AdminResetUserPassword' (Maybe (HashMap Text Text)) Text (Sensitive Text)
- newAdminResetUserPassword :: Text -> Text -> AdminResetUserPassword
- data AdminResetUserPasswordResponse = AdminResetUserPasswordResponse' Int
- newAdminResetUserPasswordResponse :: Int -> AdminResetUserPasswordResponse
- data UpdateAuthEventFeedback = UpdateAuthEventFeedback' Text (Sensitive Text) Text (Sensitive Text) FeedbackValueType
- newUpdateAuthEventFeedback :: Text -> Text -> Text -> Text -> FeedbackValueType -> UpdateAuthEventFeedback
- data UpdateAuthEventFeedbackResponse = UpdateAuthEventFeedbackResponse' Int
- newUpdateAuthEventFeedbackResponse :: Int -> UpdateAuthEventFeedbackResponse
- data CreateUserImportJob = CreateUserImportJob' Text Text Text
- newCreateUserImportJob :: Text -> Text -> Text -> CreateUserImportJob
- data CreateUserImportJobResponse = CreateUserImportJobResponse' (Maybe UserImportJobType) Int
- newCreateUserImportJobResponse :: Int -> CreateUserImportJobResponse
- data GetUser = GetUser' (Sensitive Text)
- newGetUser :: Text -> GetUser
- data GetUserResponse = GetUserResponse' (Maybe [Text]) (Maybe [MFAOptionType]) (Maybe Text) Int (Sensitive Text) [AttributeType]
- newGetUserResponse :: Int -> Text -> GetUserResponse
- data GetUICustomization = GetUICustomization' (Maybe (Sensitive Text)) Text
- newGetUICustomization :: Text -> GetUICustomization
- data GetUICustomizationResponse = GetUICustomizationResponse' Int UICustomizationType
- newGetUICustomizationResponse :: Int -> UICustomizationType -> GetUICustomizationResponse
- data GetCSVHeader = GetCSVHeader' Text
- newGetCSVHeader :: Text -> GetCSVHeader
- data GetCSVHeaderResponse = GetCSVHeaderResponse' (Maybe Text) (Maybe [Text]) Int
- newGetCSVHeaderResponse :: Int -> GetCSVHeaderResponse
- data AdminDeleteUser = AdminDeleteUser' Text (Sensitive Text)
- newAdminDeleteUser :: Text -> Text -> AdminDeleteUser
- data AdminDeleteUserResponse = AdminDeleteUserResponse' {
- newAdminDeleteUserResponse :: AdminDeleteUserResponse
- data AdminForgetDevice = AdminForgetDevice' Text (Sensitive Text) Text
- newAdminForgetDevice :: Text -> Text -> Text -> AdminForgetDevice
- data AdminForgetDeviceResponse = AdminForgetDeviceResponse' {
- newAdminForgetDeviceResponse :: AdminForgetDeviceResponse
- data DescribeResourceServer = DescribeResourceServer' Text Text
- newDescribeResourceServer :: Text -> Text -> DescribeResourceServer
- data DescribeResourceServerResponse = DescribeResourceServerResponse' Int ResourceServerType
- newDescribeResourceServerResponse :: Int -> ResourceServerType -> DescribeResourceServerResponse
- data SetUserMFAPreference = SetUserMFAPreference' (Maybe SMSMfaSettingsType) (Maybe SoftwareTokenMfaSettingsType) (Sensitive Text)
- newSetUserMFAPreference :: Text -> SetUserMFAPreference
- data SetUserMFAPreferenceResponse = SetUserMFAPreferenceResponse' Int
- newSetUserMFAPreferenceResponse :: Int -> SetUserMFAPreferenceResponse
- data AdminUpdateDeviceStatus = AdminUpdateDeviceStatus' (Maybe DeviceRememberedStatusType) Text (Sensitive Text) Text
- newAdminUpdateDeviceStatus :: Text -> Text -> Text -> AdminUpdateDeviceStatus
- data AdminUpdateDeviceStatusResponse = AdminUpdateDeviceStatusResponse' Int
- newAdminUpdateDeviceStatusResponse :: Int -> AdminUpdateDeviceStatusResponse
- data AdminCreateUser = AdminCreateUser' (Maybe (HashMap Text Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [DeliveryMediumType]) (Maybe MessageActionType) (Maybe [AttributeType]) (Maybe [AttributeType]) Text (Sensitive Text)
- newAdminCreateUser :: Text -> Text -> AdminCreateUser
- data AdminCreateUserResponse = AdminCreateUserResponse' (Maybe UserType) Int
- newAdminCreateUserResponse :: Int -> AdminCreateUserResponse
- data AddCustomAttributes = AddCustomAttributes' Text (NonEmpty SchemaAttributeType)
- newAddCustomAttributes :: Text -> NonEmpty SchemaAttributeType -> AddCustomAttributes
- data AddCustomAttributesResponse = AddCustomAttributesResponse' Int
- newAddCustomAttributesResponse :: Int -> AddCustomAttributesResponse
- data ListUserPoolClients = ListUserPoolClients' (Maybe Text) (Maybe Natural) Text
- newListUserPoolClients :: Text -> ListUserPoolClients
- data ListUserPoolClientsResponse = ListUserPoolClientsResponse' (Maybe Text) (Maybe [UserPoolClientDescription]) Int
- newListUserPoolClientsResponse :: Int -> ListUserPoolClientsResponse
- data AdminSetUserMFAPreference = AdminSetUserMFAPreference' (Maybe SMSMfaSettingsType) (Maybe SoftwareTokenMfaSettingsType) (Sensitive Text) Text
- newAdminSetUserMFAPreference :: Text -> Text -> AdminSetUserMFAPreference
- data AdminSetUserMFAPreferenceResponse = AdminSetUserMFAPreferenceResponse' Int
- newAdminSetUserMFAPreferenceResponse :: Int -> AdminSetUserMFAPreferenceResponse
- data UpdateUserPoolClient = UpdateUserPoolClient' (Maybe Natural) (Maybe [ExplicitAuthFlowsType]) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Natural) (Maybe TokenValidityUnitsType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe PreventUserExistenceErrorTypes) (Maybe Natural) (Maybe [Text]) (Maybe [Text]) (Maybe [OAuthFlowType]) (Maybe AnalyticsConfigurationType) (Maybe Text) (Maybe [Text]) Text (Sensitive Text)
- newUpdateUserPoolClient :: Text -> Text -> UpdateUserPoolClient
- data UpdateUserPoolClientResponse = UpdateUserPoolClientResponse' (Maybe UserPoolClientType) Int
- newUpdateUserPoolClientResponse :: Int -> UpdateUserPoolClientResponse
- data DeleteUserPoolClient = DeleteUserPoolClient' Text (Sensitive Text)
- newDeleteUserPoolClient :: Text -> Text -> DeleteUserPoolClient
- data DeleteUserPoolClientResponse = DeleteUserPoolClientResponse' {
- newDeleteUserPoolClientResponse :: DeleteUserPoolClientResponse
- data UpdateDeviceStatus = UpdateDeviceStatus' (Maybe DeviceRememberedStatusType) (Sensitive Text) Text
- newUpdateDeviceStatus :: Text -> Text -> UpdateDeviceStatus
- data UpdateDeviceStatusResponse = UpdateDeviceStatusResponse' Int
- newUpdateDeviceStatusResponse :: Int -> UpdateDeviceStatusResponse
- data ForgetDevice = ForgetDevice' (Maybe (Sensitive Text)) Text
- newForgetDevice :: Text -> ForgetDevice
- data ForgetDeviceResponse = ForgetDeviceResponse' {
- newForgetDeviceResponse :: ForgetDeviceResponse
- data GetSigningCertificate = GetSigningCertificate' Text
- newGetSigningCertificate :: Text -> GetSigningCertificate
- data GetSigningCertificateResponse = GetSigningCertificateResponse' (Maybe Text) Int
- newGetSigningCertificateResponse :: Int -> GetSigningCertificateResponse
- data DeleteUser = DeleteUser' (Sensitive Text)
- newDeleteUser :: Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' {
- newDeleteUserResponse :: DeleteUserResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data CreateUserPoolClient = CreateUserPoolClient' (Maybe Natural) (Maybe [ExplicitAuthFlowsType]) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe TokenValidityUnitsType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe PreventUserExistenceErrorTypes) (Maybe Natural) (Maybe [Text]) (Maybe [Text]) (Maybe [OAuthFlowType]) (Maybe AnalyticsConfigurationType) (Maybe [Text]) Text Text
- newCreateUserPoolClient :: Text -> Text -> CreateUserPoolClient
- data CreateUserPoolClientResponse = CreateUserPoolClientResponse' (Maybe UserPoolClientType) Int
- newCreateUserPoolClientResponse :: Int -> CreateUserPoolClientResponse
- data GetUserPoolMfaConfig = GetUserPoolMfaConfig' Text
- newGetUserPoolMfaConfig :: Text -> GetUserPoolMfaConfig
- data GetUserPoolMfaConfigResponse = GetUserPoolMfaConfigResponse' (Maybe SmsMfaConfigType) (Maybe SoftwareTokenMfaConfigType) (Maybe UserPoolMfaType) Int
- newGetUserPoolMfaConfigResponse :: Int -> GetUserPoolMfaConfigResponse
- data CreateResourceServer = CreateResourceServer' (Maybe [ResourceServerScopeType]) Text Text Text
- newCreateResourceServer :: Text -> Text -> Text -> CreateResourceServer
- data CreateResourceServerResponse = CreateResourceServerResponse' Int ResourceServerType
- newCreateResourceServerResponse :: Int -> ResourceServerType -> CreateResourceServerResponse
- data AdminListUserAuthEvents = AdminListUserAuthEvents' (Maybe Text) (Maybe Natural) Text (Sensitive Text)
- newAdminListUserAuthEvents :: Text -> Text -> AdminListUserAuthEvents
- data AdminListUserAuthEventsResponse = AdminListUserAuthEventsResponse' (Maybe Text) (Maybe [AuthEventType]) Int
- newAdminListUserAuthEventsResponse :: Int -> AdminListUserAuthEventsResponse
- data CreateGroup = CreateGroup' (Maybe Natural) (Maybe Text) (Maybe Text) Text Text
- newCreateGroup :: Text -> Text -> CreateGroup
- data CreateGroupResponse = CreateGroupResponse' (Maybe GroupType) Int
- newCreateGroupResponse :: Int -> CreateGroupResponse
- data AdminAddUserToGroup = AdminAddUserToGroup' Text (Sensitive Text) Text
- newAdminAddUserToGroup :: Text -> Text -> Text -> AdminAddUserToGroup
- data AdminAddUserToGroupResponse = AdminAddUserToGroupResponse' {
- newAdminAddUserToGroupResponse :: AdminAddUserToGroupResponse
- data VerifySoftwareToken = VerifySoftwareToken' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newVerifySoftwareToken :: Text -> VerifySoftwareToken
- data VerifySoftwareTokenResponse = VerifySoftwareTokenResponse' (Maybe VerifySoftwareTokenResponseType) (Maybe Text) Int
- newVerifySoftwareTokenResponse :: Int -> VerifySoftwareTokenResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data RevokeToken = RevokeToken' (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text)
- newRevokeToken :: Text -> Text -> RevokeToken
- data RevokeTokenResponse = RevokeTokenResponse' Int
- newRevokeTokenResponse :: Int -> RevokeTokenResponse
- data StopUserImportJob = StopUserImportJob' Text Text
- newStopUserImportJob :: Text -> Text -> StopUserImportJob
- data StopUserImportJobResponse = StopUserImportJobResponse' (Maybe UserImportJobType) Int
- newStopUserImportJobResponse :: Int -> StopUserImportJobResponse
- data DescribeUserImportJob = DescribeUserImportJob' Text Text
- newDescribeUserImportJob :: Text -> Text -> DescribeUserImportJob
- data DescribeUserImportJobResponse = DescribeUserImportJobResponse' (Maybe UserImportJobType) Int
- newDescribeUserImportJobResponse :: Int -> DescribeUserImportJobResponse
- data DescribeRiskConfiguration = DescribeRiskConfiguration' (Maybe (Sensitive Text)) Text
- newDescribeRiskConfiguration :: Text -> DescribeRiskConfiguration
- data DescribeRiskConfigurationResponse = DescribeRiskConfigurationResponse' Int RiskConfigurationType
- newDescribeRiskConfigurationResponse :: Int -> RiskConfigurationType -> DescribeRiskConfigurationResponse
- data DeleteGroup = DeleteGroup' Text Text
- newDeleteGroup :: Text -> Text -> DeleteGroup
- data DeleteGroupResponse = DeleteGroupResponse' {
- newDeleteGroupResponse :: DeleteGroupResponse
- data UpdateGroup = UpdateGroup' (Maybe Natural) (Maybe Text) (Maybe Text) Text Text
- newUpdateGroup :: Text -> Text -> UpdateGroup
- data UpdateGroupResponse = UpdateGroupResponse' (Maybe GroupType) Int
- newUpdateGroupResponse :: Int -> UpdateGroupResponse
- data GlobalSignOut = GlobalSignOut' (Sensitive Text)
- newGlobalSignOut :: Text -> GlobalSignOut
- data GlobalSignOutResponse = GlobalSignOutResponse' Int
- newGlobalSignOutResponse :: Int -> GlobalSignOutResponse
- data ListGroups = ListGroups' (Maybe Text) (Maybe Natural) Text
- newListGroups :: Text -> ListGroups
- data ListGroupsResponse = ListGroupsResponse' (Maybe [GroupType]) (Maybe Text) Int
- newListGroupsResponse :: Int -> ListGroupsResponse
- data UpdateIdentityProvider = UpdateIdentityProvider' (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text Text
- newUpdateIdentityProvider :: Text -> Text -> UpdateIdentityProvider
- data UpdateIdentityProviderResponse = UpdateIdentityProviderResponse' Int IdentityProviderType
- newUpdateIdentityProviderResponse :: Int -> IdentityProviderType -> UpdateIdentityProviderResponse
- data DeleteIdentityProvider = DeleteIdentityProvider' Text Text
- newDeleteIdentityProvider :: Text -> Text -> DeleteIdentityProvider
- data DeleteIdentityProviderResponse = DeleteIdentityProviderResponse' {
- newDeleteIdentityProviderResponse :: DeleteIdentityProviderResponse
- data ListResourceServers = ListResourceServers' (Maybe Text) (Maybe Natural) Text
- newListResourceServers :: Text -> ListResourceServers
- data ListResourceServersResponse = ListResourceServersResponse' (Maybe Text) Int [ResourceServerType]
- newListResourceServersResponse :: Int -> ListResourceServersResponse
- data AdminRespondToAuthChallenge = AdminRespondToAuthChallenge' (Maybe (HashMap Text Text)) (Maybe ContextDataType) (Maybe AnalyticsMetadataType) (Maybe (HashMap Text Text)) (Maybe Text) Text (Sensitive Text) ChallengeNameType
- newAdminRespondToAuthChallenge :: Text -> Text -> ChallengeNameType -> AdminRespondToAuthChallenge
- data AdminRespondToAuthChallengeResponse = AdminRespondToAuthChallengeResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int
- newAdminRespondToAuthChallengeResponse :: Int -> AdminRespondToAuthChallengeResponse
- data SetUserSettings = SetUserSettings' (Sensitive Text) [MFAOptionType]
- newSetUserSettings :: Text -> SetUserSettings
- data SetUserSettingsResponse = SetUserSettingsResponse' Int
- newSetUserSettingsResponse :: Int -> SetUserSettingsResponse
- data AdminListDevices = AdminListDevices' (Maybe Text) (Maybe Natural) Text (Sensitive Text)
- newAdminListDevices :: Text -> Text -> AdminListDevices
- data AdminListDevicesResponse = AdminListDevicesResponse' (Maybe Text) (Maybe [DeviceType]) Int
- newAdminListDevicesResponse :: Int -> AdminListDevicesResponse
- data DescribeUserPoolClient = DescribeUserPoolClient' Text (Sensitive Text)
- newDescribeUserPoolClient :: Text -> Text -> DescribeUserPoolClient
- data DescribeUserPoolClientResponse = DescribeUserPoolClientResponse' (Maybe UserPoolClientType) Int
- newDescribeUserPoolClientResponse :: Int -> DescribeUserPoolClientResponse
- data ResendConfirmationCode = ResendConfirmationCode' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text)
- newResendConfirmationCode :: Text -> Text -> ResendConfirmationCode
- data ResendConfirmationCodeResponse = ResendConfirmationCodeResponse' (Maybe CodeDeliveryDetailsType) Int
- newResendConfirmationCodeResponse :: Int -> ResendConfirmationCodeResponse
- data GetGroup = GetGroup' Text Text
- newGetGroup :: Text -> Text -> GetGroup
- data GetGroupResponse = GetGroupResponse' (Maybe GroupType) Int
- newGetGroupResponse :: Int -> GetGroupResponse
- data AdminSetUserSettings = AdminSetUserSettings' Text (Sensitive Text) [MFAOptionType]
- newAdminSetUserSettings :: Text -> Text -> AdminSetUserSettings
- data AdminSetUserSettingsResponse = AdminSetUserSettingsResponse' Int
- newAdminSetUserSettingsResponse :: Int -> AdminSetUserSettingsResponse
- data ListDevices = ListDevices' (Maybe Text) (Maybe Natural) (Sensitive Text)
- newListDevices :: Text -> ListDevices
- data ListDevicesResponse = ListDevicesResponse' (Maybe Text) (Maybe [DeviceType]) Int
- newListDevicesResponse :: Int -> ListDevicesResponse
- newtype AccountTakeoverEventActionType where
- AccountTakeoverEventActionType' { }
- pattern AccountTakeoverEventActionType_BLOCK :: AccountTakeoverEventActionType
- pattern AccountTakeoverEventActionType_MFA_IF_CONFIGURED :: AccountTakeoverEventActionType
- pattern AccountTakeoverEventActionType_MFA_REQUIRED :: AccountTakeoverEventActionType
- pattern AccountTakeoverEventActionType_NO_ACTION :: AccountTakeoverEventActionType
- newtype AdvancedSecurityModeType where
- newtype AliasAttributeType where
- newtype AttributeDataType where
- AttributeDataType' { }
- pattern AttributeDataType_Boolean :: AttributeDataType
- pattern AttributeDataType_DateTime :: AttributeDataType
- pattern AttributeDataType_Number :: AttributeDataType
- pattern AttributeDataType_String :: AttributeDataType
- newtype AuthFlowType where
- AuthFlowType' { }
- pattern AuthFlowType_ADMIN_NO_SRP_AUTH :: AuthFlowType
- pattern AuthFlowType_ADMIN_USER_PASSWORD_AUTH :: AuthFlowType
- pattern AuthFlowType_CUSTOM_AUTH :: AuthFlowType
- pattern AuthFlowType_REFRESH_TOKEN :: AuthFlowType
- pattern AuthFlowType_REFRESH_TOKEN_AUTH :: AuthFlowType
- pattern AuthFlowType_USER_PASSWORD_AUTH :: AuthFlowType
- pattern AuthFlowType_USER_SRP_AUTH :: AuthFlowType
- newtype ChallengeName where
- ChallengeName' { }
- pattern ChallengeName_Mfa :: ChallengeName
- pattern ChallengeName_Password :: ChallengeName
- newtype ChallengeNameType where
- ChallengeNameType' { }
- pattern ChallengeNameType_ADMIN_NO_SRP_AUTH :: ChallengeNameType
- pattern ChallengeNameType_CUSTOM_CHALLENGE :: ChallengeNameType
- pattern ChallengeNameType_DEVICE_PASSWORD_VERIFIER :: ChallengeNameType
- pattern ChallengeNameType_DEVICE_SRP_AUTH :: ChallengeNameType
- pattern ChallengeNameType_MFA_SETUP :: ChallengeNameType
- pattern ChallengeNameType_NEW_PASSWORD_REQUIRED :: ChallengeNameType
- pattern ChallengeNameType_PASSWORD_VERIFIER :: ChallengeNameType
- pattern ChallengeNameType_SELECT_MFA_TYPE :: ChallengeNameType
- pattern ChallengeNameType_SMS_MFA :: ChallengeNameType
- pattern ChallengeNameType_SOFTWARE_TOKEN_MFA :: ChallengeNameType
- newtype ChallengeResponse where
- ChallengeResponse' { }
- pattern ChallengeResponse_Failure :: ChallengeResponse
- pattern ChallengeResponse_Success :: ChallengeResponse
- newtype CompromisedCredentialsEventActionType where
- newtype CustomEmailSenderLambdaVersionType where
- newtype CustomSMSSenderLambdaVersionType where
- newtype DefaultEmailOptionType where
- newtype DeliveryMediumType where
- DeliveryMediumType' { }
- pattern DeliveryMediumType_EMAIL :: DeliveryMediumType
- pattern DeliveryMediumType_SMS :: DeliveryMediumType
- newtype DeviceRememberedStatusType where
- newtype DomainStatusType where
- DomainStatusType' { }
- pattern DomainStatusType_ACTIVE :: DomainStatusType
- pattern DomainStatusType_CREATING :: DomainStatusType
- pattern DomainStatusType_DELETING :: DomainStatusType
- pattern DomainStatusType_FAILED :: DomainStatusType
- pattern DomainStatusType_UPDATING :: DomainStatusType
- newtype EmailSendingAccountType where
- newtype EventFilterType where
- EventFilterType' { }
- pattern EventFilterType_PASSWORD_CHANGE :: EventFilterType
- pattern EventFilterType_SIGN_IN :: EventFilterType
- pattern EventFilterType_SIGN_UP :: EventFilterType
- newtype EventResponseType where
- EventResponseType' { }
- pattern EventResponseType_Failure :: EventResponseType
- pattern EventResponseType_Success :: EventResponseType
- newtype EventType where
- EventType' { }
- pattern EventType_ForgotPassword :: EventType
- pattern EventType_SignIn :: EventType
- pattern EventType_SignUp :: EventType
- newtype ExplicitAuthFlowsType where
- ExplicitAuthFlowsType' { }
- pattern ExplicitAuthFlowsType_ADMIN_NO_SRP_AUTH :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_ALLOW_ADMIN_USER_PASSWORD_AUTH :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_ALLOW_CUSTOM_AUTH :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_ALLOW_REFRESH_TOKEN_AUTH :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_ALLOW_USER_PASSWORD_AUTH :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_ALLOW_USER_SRP_AUTH :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_CUSTOM_AUTH_FLOW_ONLY :: ExplicitAuthFlowsType
- pattern ExplicitAuthFlowsType_USER_PASSWORD_AUTH :: ExplicitAuthFlowsType
- newtype FeedbackValueType where
- FeedbackValueType' { }
- pattern FeedbackValueType_Invalid :: FeedbackValueType
- pattern FeedbackValueType_Valid :: FeedbackValueType
- newtype IdentityProviderTypeType where
- IdentityProviderTypeType' { }
- pattern IdentityProviderTypeType_Facebook :: IdentityProviderTypeType
- pattern IdentityProviderTypeType_Google :: IdentityProviderTypeType
- pattern IdentityProviderTypeType_LoginWithAmazon :: IdentityProviderTypeType
- pattern IdentityProviderTypeType_OIDC :: IdentityProviderTypeType
- pattern IdentityProviderTypeType_SAML :: IdentityProviderTypeType
- pattern IdentityProviderTypeType_SignInWithApple :: IdentityProviderTypeType
- newtype MessageActionType where
- MessageActionType' { }
- pattern MessageActionType_RESEND :: MessageActionType
- pattern MessageActionType_SUPPRESS :: MessageActionType
- newtype OAuthFlowType where
- OAuthFlowType' { }
- pattern OAuthFlowType_Client_credentials :: OAuthFlowType
- pattern OAuthFlowType_Code :: OAuthFlowType
- pattern OAuthFlowType_Implicit :: OAuthFlowType
- newtype PreventUserExistenceErrorTypes where
- newtype RecoveryOptionNameType where
- newtype RiskDecisionType where
- RiskDecisionType' { }
- pattern RiskDecisionType_AccountTakeover :: RiskDecisionType
- pattern RiskDecisionType_Block :: RiskDecisionType
- pattern RiskDecisionType_NoRisk :: RiskDecisionType
- newtype RiskLevelType where
- RiskLevelType' { }
- pattern RiskLevelType_High :: RiskLevelType
- pattern RiskLevelType_Low :: RiskLevelType
- pattern RiskLevelType_Medium :: RiskLevelType
- newtype StatusType where
- StatusType' { }
- pattern StatusType_Disabled :: StatusType
- pattern StatusType_Enabled :: StatusType
- newtype TimeUnitsType where
- TimeUnitsType' { }
- pattern TimeUnitsType_Days :: TimeUnitsType
- pattern TimeUnitsType_Hours :: TimeUnitsType
- pattern TimeUnitsType_Minutes :: TimeUnitsType
- pattern TimeUnitsType_Seconds :: TimeUnitsType
- newtype UserImportJobStatusType where
- UserImportJobStatusType' { }
- pattern UserImportJobStatusType_Created :: UserImportJobStatusType
- pattern UserImportJobStatusType_Expired :: UserImportJobStatusType
- pattern UserImportJobStatusType_Failed :: UserImportJobStatusType
- pattern UserImportJobStatusType_InProgress :: UserImportJobStatusType
- pattern UserImportJobStatusType_Pending :: UserImportJobStatusType
- pattern UserImportJobStatusType_Stopped :: UserImportJobStatusType
- pattern UserImportJobStatusType_Stopping :: UserImportJobStatusType
- pattern UserImportJobStatusType_Succeeded :: UserImportJobStatusType
- newtype UserPoolMfaType where
- UserPoolMfaType' { }
- pattern UserPoolMfaType_OFF :: UserPoolMfaType
- pattern UserPoolMfaType_ON :: UserPoolMfaType
- pattern UserPoolMfaType_OPTIONAL :: UserPoolMfaType
- newtype UserStatusType where
- UserStatusType' { }
- pattern UserStatusType_ARCHIVED :: UserStatusType
- pattern UserStatusType_COMPROMISED :: UserStatusType
- pattern UserStatusType_CONFIRMED :: UserStatusType
- pattern UserStatusType_FORCE_CHANGE_PASSWORD :: UserStatusType
- pattern UserStatusType_RESET_REQUIRED :: UserStatusType
- pattern UserStatusType_UNCONFIRMED :: UserStatusType
- pattern UserStatusType_UNKNOWN :: UserStatusType
- newtype UsernameAttributeType where
- newtype VerifiedAttributeType where
- newtype VerifySoftwareTokenResponseType where
- data AccountRecoverySettingType = AccountRecoverySettingType' (Maybe (NonEmpty RecoveryOptionType))
- newAccountRecoverySettingType :: AccountRecoverySettingType
- data AccountTakeoverActionType = AccountTakeoverActionType' Bool AccountTakeoverEventActionType
- newAccountTakeoverActionType :: Bool -> AccountTakeoverEventActionType -> AccountTakeoverActionType
- data AccountTakeoverActionsType = AccountTakeoverActionsType' (Maybe AccountTakeoverActionType) (Maybe AccountTakeoverActionType) (Maybe AccountTakeoverActionType)
- newAccountTakeoverActionsType :: AccountTakeoverActionsType
- data AccountTakeoverRiskConfigurationType = AccountTakeoverRiskConfigurationType' (Maybe NotifyConfigurationType) AccountTakeoverActionsType
- newAccountTakeoverRiskConfigurationType :: AccountTakeoverActionsType -> AccountTakeoverRiskConfigurationType
- data AdminCreateUserConfigType = AdminCreateUserConfigType' (Maybe Bool) (Maybe Natural) (Maybe MessageTemplateType)
- newAdminCreateUserConfigType :: AdminCreateUserConfigType
- data AnalyticsConfigurationType = AnalyticsConfigurationType' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newAnalyticsConfigurationType :: AnalyticsConfigurationType
- data AnalyticsMetadataType = AnalyticsMetadataType' (Maybe Text)
- newAnalyticsMetadataType :: AnalyticsMetadataType
- data AttributeType = AttributeType' (Maybe (Sensitive Text)) Text
- newAttributeType :: Text -> AttributeType
- data AuthEventType = AuthEventType' (Maybe EventRiskType) (Maybe EventResponseType) (Maybe EventContextDataType) (Maybe [ChallengeResponseType]) (Maybe EventType) (Maybe POSIX) (Maybe EventFeedbackType) (Maybe Text)
- newAuthEventType :: AuthEventType
- data AuthenticationResultType = AuthenticationResultType' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe NewDeviceMetadataType) (Maybe Int) (Maybe Text) (Maybe (Sensitive Text))
- newAuthenticationResultType :: AuthenticationResultType
- data ChallengeResponseType = ChallengeResponseType' (Maybe ChallengeName) (Maybe ChallengeResponse)
- newChallengeResponseType :: ChallengeResponseType
- data CodeDeliveryDetailsType = CodeDeliveryDetailsType' (Maybe Text) (Maybe DeliveryMediumType) (Maybe Text)
- newCodeDeliveryDetailsType :: CodeDeliveryDetailsType
- data CompromisedCredentialsActionsType = CompromisedCredentialsActionsType' CompromisedCredentialsEventActionType
- newCompromisedCredentialsActionsType :: CompromisedCredentialsEventActionType -> CompromisedCredentialsActionsType
- data CompromisedCredentialsRiskConfigurationType = CompromisedCredentialsRiskConfigurationType' (Maybe [EventFilterType]) CompromisedCredentialsActionsType
- newCompromisedCredentialsRiskConfigurationType :: CompromisedCredentialsActionsType -> CompromisedCredentialsRiskConfigurationType
- data ContextDataType = ContextDataType' (Maybe Text) Text Text Text [HttpHeader]
- newContextDataType :: Text -> Text -> Text -> ContextDataType
- data CustomDomainConfigType = CustomDomainConfigType' Text
- newCustomDomainConfigType :: Text -> CustomDomainConfigType
- data CustomEmailLambdaVersionConfigType = CustomEmailLambdaVersionConfigType' CustomEmailSenderLambdaVersionType Text
- newCustomEmailLambdaVersionConfigType :: CustomEmailSenderLambdaVersionType -> Text -> CustomEmailLambdaVersionConfigType
- data CustomSMSLambdaVersionConfigType = CustomSMSLambdaVersionConfigType' CustomSMSSenderLambdaVersionType Text
- newCustomSMSLambdaVersionConfigType :: CustomSMSSenderLambdaVersionType -> Text -> CustomSMSLambdaVersionConfigType
- data DeviceConfigurationType = DeviceConfigurationType' (Maybe Bool) (Maybe Bool)
- newDeviceConfigurationType :: DeviceConfigurationType
- data DeviceSecretVerifierConfigType = DeviceSecretVerifierConfigType' (Maybe Text) (Maybe Text)
- newDeviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType
- data DeviceType = DeviceType' (Maybe POSIX) (Maybe POSIX) (Maybe [AttributeType]) (Maybe Text) (Maybe POSIX)
- newDeviceType :: DeviceType
- data DomainDescriptionType = DomainDescriptionType' (Maybe DomainStatusType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CustomDomainConfigType) (Maybe Text) (Maybe Text)
- newDomainDescriptionType :: DomainDescriptionType
- data EmailConfigurationType = EmailConfigurationType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EmailSendingAccountType)
- newEmailConfigurationType :: EmailConfigurationType
- data EventContextDataType = EventContextDataType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEventContextDataType :: EventContextDataType
- data EventFeedbackType = EventFeedbackType' (Maybe POSIX) FeedbackValueType Text
- newEventFeedbackType :: FeedbackValueType -> Text -> EventFeedbackType
- data EventRiskType = EventRiskType' (Maybe Bool) (Maybe RiskLevelType) (Maybe RiskDecisionType)
- newEventRiskType :: EventRiskType
- data GroupType = GroupType' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newGroupType :: GroupType
- data HttpHeader = HttpHeader' (Maybe Text) (Maybe Text)
- newHttpHeader :: HttpHeader
- data IdentityProviderType = IdentityProviderType' (Maybe POSIX) (Maybe Text) (Maybe IdentityProviderTypeType) (Maybe POSIX) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text)
- newIdentityProviderType :: IdentityProviderType
- data LambdaConfigType = LambdaConfigType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CustomSMSLambdaVersionConfigType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CustomEmailLambdaVersionConfigType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newLambdaConfigType :: LambdaConfigType
- data MFAOptionType = MFAOptionType' (Maybe DeliveryMediumType) (Maybe Text)
- newMFAOptionType :: MFAOptionType
- data MessageTemplateType = MessageTemplateType' (Maybe Text) (Maybe Text) (Maybe Text)
- newMessageTemplateType :: MessageTemplateType
- data NewDeviceMetadataType = NewDeviceMetadataType' (Maybe Text) (Maybe Text)
- newNewDeviceMetadataType :: NewDeviceMetadataType
- data NotifyConfigurationType = NotifyConfigurationType' (Maybe NotifyEmailType) (Maybe Text) (Maybe Text) (Maybe NotifyEmailType) (Maybe NotifyEmailType) Text
- newNotifyConfigurationType :: Text -> NotifyConfigurationType
- data NotifyEmailType = NotifyEmailType' (Maybe Text) (Maybe Text) Text
- newNotifyEmailType :: Text -> NotifyEmailType
- data NumberAttributeConstraintsType = NumberAttributeConstraintsType' (Maybe Text) (Maybe Text)
- newNumberAttributeConstraintsType :: NumberAttributeConstraintsType
- data PasswordPolicyType = PasswordPolicyType' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Bool) (Maybe Natural)
- newPasswordPolicyType :: PasswordPolicyType
- data ProviderDescription = ProviderDescription' (Maybe POSIX) (Maybe IdentityProviderTypeType) (Maybe POSIX) (Maybe Text)
- newProviderDescription :: ProviderDescription
- data ProviderUserIdentifierType = ProviderUserIdentifierType' (Maybe Text) (Maybe Text) (Maybe Text)
- newProviderUserIdentifierType :: ProviderUserIdentifierType
- data RecoveryOptionType = RecoveryOptionType' Natural RecoveryOptionNameType
- newRecoveryOptionType :: Natural -> RecoveryOptionNameType -> RecoveryOptionType
- data ResourceServerScopeType = ResourceServerScopeType' Text Text
- newResourceServerScopeType :: Text -> Text -> ResourceServerScopeType
- data ResourceServerType = ResourceServerType' (Maybe Text) (Maybe Text) (Maybe [ResourceServerScopeType]) (Maybe Text)
- newResourceServerType :: ResourceServerType
- data RiskConfigurationType = RiskConfigurationType' (Maybe RiskExceptionConfigurationType) (Maybe (Sensitive Text)) (Maybe AccountTakeoverRiskConfigurationType) (Maybe POSIX) (Maybe Text) (Maybe CompromisedCredentialsRiskConfigurationType)
- newRiskConfigurationType :: RiskConfigurationType
- data RiskExceptionConfigurationType = RiskExceptionConfigurationType' (Maybe [Text]) (Maybe [Text])
- newRiskExceptionConfigurationType :: RiskExceptionConfigurationType
- data SMSMfaSettingsType = SMSMfaSettingsType' (Maybe Bool) (Maybe Bool)
- newSMSMfaSettingsType :: SMSMfaSettingsType
- data SchemaAttributeType = SchemaAttributeType' (Maybe NumberAttributeConstraintsType) (Maybe Bool) (Maybe AttributeDataType) (Maybe StringAttributeConstraintsType) (Maybe Text) (Maybe Bool) (Maybe Bool)
- newSchemaAttributeType :: SchemaAttributeType
- data SmsConfigurationType = SmsConfigurationType' (Maybe Text) Text
- newSmsConfigurationType :: Text -> SmsConfigurationType
- data SmsMfaConfigType = SmsMfaConfigType' (Maybe Text) (Maybe SmsConfigurationType)
- newSmsMfaConfigType :: SmsMfaConfigType
- data SoftwareTokenMfaConfigType = SoftwareTokenMfaConfigType' (Maybe Bool)
- newSoftwareTokenMfaConfigType :: SoftwareTokenMfaConfigType
- data SoftwareTokenMfaSettingsType = SoftwareTokenMfaSettingsType' (Maybe Bool) (Maybe Bool)
- newSoftwareTokenMfaSettingsType :: SoftwareTokenMfaSettingsType
- data StringAttributeConstraintsType = StringAttributeConstraintsType' (Maybe Text) (Maybe Text)
- newStringAttributeConstraintsType :: StringAttributeConstraintsType
- data TokenValidityUnitsType = TokenValidityUnitsType' (Maybe TimeUnitsType) (Maybe TimeUnitsType) (Maybe TimeUnitsType)
- newTokenValidityUnitsType :: TokenValidityUnitsType
- data UICustomizationType = UICustomizationType' (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newUICustomizationType :: UICustomizationType
- data UserContextDataType = UserContextDataType' (Maybe Text)
- newUserContextDataType :: UserContextDataType
- data UserImportJobType = UserImportJobType' (Maybe UserImportJobStatusType) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Integer)
- newUserImportJobType :: UserImportJobType
- data UserPoolAddOnsType = UserPoolAddOnsType' AdvancedSecurityModeType
- newUserPoolAddOnsType :: AdvancedSecurityModeType -> UserPoolAddOnsType
- data UserPoolClientDescription = UserPoolClientDescription' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text)
- newUserPoolClientDescription :: UserPoolClientDescription
- data UserPoolClientType = UserPoolClientType' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe [ExplicitAuthFlowsType]) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe TokenValidityUnitsType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe PreventUserExistenceErrorTypes) (Maybe Natural) (Maybe POSIX) (Maybe [Text]) (Maybe [Text]) (Maybe [OAuthFlowType]) (Maybe AnalyticsConfigurationType) (Maybe Text) (Maybe [Text])
- newUserPoolClientType :: UserPoolClientType
- data UserPoolDescriptionType = UserPoolDescriptionType' (Maybe StatusType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe LambdaConfigType)
- newUserPoolDescriptionType :: UserPoolDescriptionType
- data UserPoolPolicyType = UserPoolPolicyType' (Maybe PasswordPolicyType)
- newUserPoolPolicyType :: UserPoolPolicyType
- data UserPoolType = UserPoolType' (Maybe StatusType) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe POSIX) (Maybe VerificationMessageTemplateType) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserPoolAddOnsType) (Maybe (NonEmpty SchemaAttributeType)) (Maybe Text) (Maybe [UsernameAttributeType]) (Maybe [AliasAttributeType]) (Maybe AccountRecoverySettingType) (Maybe EmailConfigurationType) (Maybe Text) (Maybe Text) (Maybe UserPoolMfaType) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe LambdaConfigType) (Maybe SmsConfigurationType) (Maybe AdminCreateUserConfigType) (Maybe DeviceConfigurationType) (Maybe [VerifiedAttributeType]) (Maybe UserPoolPolicyType) (Maybe UsernameConfigurationType)
- newUserPoolType :: UserPoolType
- data UserType = UserType' (Maybe Bool) (Maybe UserStatusType) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe [AttributeType]) (Maybe [MFAOptionType]) (Maybe POSIX)
- newUserType :: UserType
- data UsernameConfigurationType = UsernameConfigurationType' Bool
- newUsernameConfigurationType :: Bool -> UsernameConfigurationType
- data VerificationMessageTemplateType = VerificationMessageTemplateType' (Maybe DefaultEmailOptionType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newVerificationMessageTemplateType :: VerificationMessageTemplateType
Service Configuration
defaultService :: 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.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when you attempt to perform an operation that is not enabled for the user pool client.
InvalidLambdaResponseException
_InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid 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 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.
SoftwareTokenMFANotFoundException
_SoftwareTokenMFANotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled for the user pool.
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.
UserPoolAddOnNotEnabledException
_UserPoolAddOnNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when user pool add-ons are not enabled.
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 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).
EnableSoftwareTokenMFAException
_EnableSoftwareTokenMFAException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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
_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.
UnauthorizedException
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the request is not authorized. This can happen due to an invalid access token in the request.
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.
UnsupportedTokenTypeException
_UnsupportedTokenTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when an unsupported token is passed to an operation.
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 Amazon Web Services 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
data DeleteUserPool Source #
Represents the request to delete a user pool.
See: newDeleteUserPool smart constructor.
Constructors
| DeleteUserPool' Text |
Instances
Arguments
| :: Text | |
| -> DeleteUserPool |
Create a value of DeleteUserPool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DeleteUserPool', deleteUserPool_userPoolId - The user pool ID for the user pool you want to delete.
data DeleteUserPoolResponse Source #
See: newDeleteUserPoolResponse smart constructor.
Constructors
| DeleteUserPoolResponse' | |
Instances
| Eq DeleteUserPoolResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPool Methods (==) :: DeleteUserPoolResponse -> DeleteUserPoolResponse -> Bool # (/=) :: DeleteUserPoolResponse -> DeleteUserPoolResponse -> Bool # | |
| Read DeleteUserPoolResponse Source # | |
| Show DeleteUserPoolResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPool Methods showsPrec :: Int -> DeleteUserPoolResponse -> ShowS # show :: DeleteUserPoolResponse -> String # showList :: [DeleteUserPoolResponse] -> ShowS # | |
| Generic DeleteUserPoolResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPool Associated Types type Rep DeleteUserPoolResponse :: Type -> Type # Methods from :: DeleteUserPoolResponse -> Rep DeleteUserPoolResponse x # to :: Rep DeleteUserPoolResponse x -> DeleteUserPoolResponse # | |
| NFData DeleteUserPoolResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPool Methods rnf :: DeleteUserPoolResponse -> () # | |
| type Rep DeleteUserPoolResponse Source # | |
newDeleteUserPoolResponse :: DeleteUserPoolResponse Source #
Create a value of DeleteUserPoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateUserPool
data UpdateUserPool Source #
Represents the request to update the user pool.
See: newUpdateUserPool smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> UpdateUserPool |
Create a value of UpdateUserPool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolTags:UpdateUserPool', updateUserPool_userPoolTags - The tag keys and values to assign to the user pool. A tag is a label
that you can use to categorize and manage user pools in different ways,
such as by purpose, owner, environment, or other criteria.
$sel:verificationMessageTemplate:UpdateUserPool', updateUserPool_verificationMessageTemplate - The template for verification messages.
$sel:emailVerificationMessage:UpdateUserPool', updateUserPool_emailVerificationMessage - The contents of the email verification message.
$sel:smsAuthenticationMessage:UpdateUserPool', updateUserPool_smsAuthenticationMessage - The contents of the SMS authentication message.
$sel:userPoolAddOns:UpdateUserPool', updateUserPool_userPoolAddOns - Used to enable advanced security risk detection. Set the key
AdvancedSecurityMode to the value "AUDIT".
$sel:emailVerificationSubject:UpdateUserPool', updateUserPool_emailVerificationSubject - The subject of the email verification message.
$sel:accountRecoverySetting:UpdateUserPool', updateUserPool_accountRecoverySetting - Use this setting to define which verified available method a user can
use to recover their password when they call ForgotPassword. It allows
you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password
recovery mechanism if the user also has SMS MFA enabled. In the absence
of this setting, Cognito uses the legacy behavior to determine the
recovery method where SMS is preferred over email.
$sel:emailConfiguration:UpdateUserPool', updateUserPool_emailConfiguration - Email configuration.
$sel:smsVerificationMessage:UpdateUserPool', updateUserPool_smsVerificationMessage - A container with information about the SMS verification message.
$sel:mfaConfiguration:UpdateUserPool', updateUserPool_mfaConfiguration - 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 ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.OPTIONAL- Users have the option when registering to create an MFA token.
$sel:lambdaConfig:UpdateUserPool', updateUserPool_lambdaConfig - The Lambda configuration information from the request to update the user
pool.
$sel:smsConfiguration:UpdateUserPool', updateUserPool_smsConfiguration - SMS configuration.
$sel:adminCreateUserConfig:UpdateUserPool', updateUserPool_adminCreateUserConfig - The configuration for AdminCreateUser requests.
$sel:deviceConfiguration:UpdateUserPool', updateUserPool_deviceConfiguration - Device configuration.
$sel:autoVerifiedAttributes:UpdateUserPool', updateUserPool_autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
$sel:policies:UpdateUserPool', updateUserPool_policies - A container with the policies you wish to update in a user pool.
$sel:userPoolId:UpdateUserPool', updateUserPool_userPoolId - The user pool ID for the user pool you want to update.
data UpdateUserPoolResponse Source #
Represents the response from the server when you make a request to update the user pool.
See: newUpdateUserPoolResponse smart constructor.
Constructors
| UpdateUserPoolResponse' Int |
Instances
newUpdateUserPoolResponse Source #
Create a value of UpdateUserPoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateUserPoolResponse', updateUserPoolResponse_httpStatus - The response's http status code.
UpdateUserPoolDomain
data UpdateUserPoolDomain Source #
The UpdateUserPoolDomain request input.
See: newUpdateUserPoolDomain smart constructor.
Constructors
| UpdateUserPoolDomain' Text Text CustomDomainConfigType |
Instances
newUpdateUserPoolDomain Source #
Arguments
| :: Text | |
| -> Text | |
| -> CustomDomainConfigType | |
| -> UpdateUserPoolDomain |
Create a value of UpdateUserPoolDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:UpdateUserPoolDomain', updateUserPoolDomain_domain - The domain name for the custom domain that hosts the sign-up and sign-in
pages for your application. For example: auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names.
$sel:userPoolId:UpdateUserPoolDomain', updateUserPoolDomain_userPoolId - The ID of the user pool that is associated with the custom domain that
you are updating the certificate for.
$sel:customDomainConfig:UpdateUserPoolDomain', updateUserPoolDomain_customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in
pages for your application. Use this object to specify an SSL
certificate that is managed by ACM.
data UpdateUserPoolDomainResponse Source #
The UpdateUserPoolDomain response output.
See: newUpdateUserPoolDomainResponse smart constructor.
Constructors
| UpdateUserPoolDomainResponse' (Maybe Text) Int |
Instances
newUpdateUserPoolDomainResponse Source #
Create a value of UpdateUserPoolDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudFrontDomain:UpdateUserPoolDomainResponse', updateUserPoolDomainResponse_cloudFrontDomain - The Amazon CloudFront endpoint that Amazon Cognito set up when you added
the custom domain to your user pool.
$sel:httpStatus:UpdateUserPoolDomainResponse', updateUserPoolDomainResponse_httpStatus - The response's http status code.
DeleteUserPoolDomain
data DeleteUserPoolDomain Source #
See: newDeleteUserPoolDomain smart constructor.
Constructors
| DeleteUserPoolDomain' Text Text |
Instances
newDeleteUserPoolDomain Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteUserPoolDomain |
Create a value of DeleteUserPoolDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:DeleteUserPoolDomain', deleteUserPoolDomain_domain - The domain string.
$sel:userPoolId:DeleteUserPoolDomain', deleteUserPoolDomain_userPoolId - The user pool ID.
data DeleteUserPoolDomainResponse Source #
See: newDeleteUserPoolDomainResponse smart constructor.
Constructors
| DeleteUserPoolDomainResponse' Int |
Instances
newDeleteUserPoolDomainResponse Source #
Create a value of DeleteUserPoolDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUserPoolDomainResponse', deleteUserPoolDomainResponse_httpStatus - The response's http status code.
AdminInitiateAuth
data AdminInitiateAuth Source #
Initiates the authorization request, as an administrator.
See: newAdminInitiateAuth smart constructor.
Constructors
| AdminInitiateAuth' (Maybe (HashMap Text Text)) (Maybe ContextDataType) (Maybe AnalyticsMetadataType) (Maybe (Sensitive (HashMap Text Text))) Text (Sensitive Text) AuthFlowType |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AuthFlowType | |
| -> AdminInitiateAuth |
Create a value of AdminInitiateAuth with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminInitiateAuth', adminInitiateAuth_clientMetadata - A map of custom key-value pairs that you can provide as input for
certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
- Pre signup
- Pre authentication
- User migration
When Amazon Cognito invokes the functions for these triggers, it passes
a JSON payload, which the function receives as input. This payload
contains a validationData attribute, which provides the data that you
assigned to the ClientMetadata parameter in your AdminInitiateAuth
request. In your function code in Lambda, you can process the
validationData value to enhance your workflow for your specific needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Verify auth challenge
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:contextData:AdminInitiateAuth', adminInitiateAuth_contextData - 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.
$sel:analyticsMetadata:AdminInitiateAuth', adminInitiateAuth_analyticsMetadata - The analytics metadata for collecting Amazon Pinpoint metrics for
AdminInitiateAuth calls.
$sel:authParameters:AdminInitiateAuth', adminInitiateAuth_authParameters - The authentication parameters. These are inputs corresponding to the
AuthFlow that you are invoking. The required values depend on the
value of AuthFlow:
- For
USER_SRP_AUTH:USERNAME(required),SRP_A(required),SECRET_HASH(required if the app client is configured with a client secret),DEVICE_KEY. - For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN:REFRESH_TOKEN(required),SECRET_HASH(required if the app client is configured with a client secret),DEVICE_KEY. - For
ADMIN_NO_SRP_AUTH:USERNAME(required),SECRET_HASH(if app client is configured with client secret),PASSWORD(required),DEVICE_KEY. - For
CUSTOM_AUTH:USERNAME(required),SECRET_HASH(if app client is configured with client secret),DEVICE_KEY. To start the authentication flow with password verification, includeChallengeName: SRP_AandSRP_A: (The SRP_A Value).
$sel:userPoolId:AdminInitiateAuth', adminInitiateAuth_userPoolId - The ID of the Amazon Cognito user pool.
$sel:clientId:AdminInitiateAuth', adminInitiateAuth_clientId - The app client ID.
$sel:authFlow:AdminInitiateAuth', adminInitiateAuth_authFlow - The authentication flow for this call to execute. The API action will
depend on this value. For example:
REFRESH_TOKEN_AUTHwill take in a valid refresh token and return new tokens.USER_SRP_AUTHwill take inUSERNAMEandSRP_Aand return the SRP variables to be used for next challenge execution.USER_PASSWORD_AUTHwill take inUSERNAMEandPASSWORDand return the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.CUSTOM_AUTH: Custom authentication flow.ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces theADMIN_NO_SRP_AUTHauthentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
data AdminInitiateAuthResponse Source #
Initiates the authentication response, as an administrator.
See: newAdminInitiateAuthResponse smart constructor.
Constructors
| AdminInitiateAuthResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int |
Instances
newAdminInitiateAuthResponse Source #
Create a value of AdminInitiateAuthResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:challengeName:AdminInitiateAuthResponse', adminInitiateAuthResponse_challengeName - The name of the challenge which you are responding to with this call.
This is returned to you in the AdminInitiateAuth response if you need
to pass another challenge.
MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are presented with anMFA_SETUPchallenge. The user must set up at least one MFA type to continue to authenticate.SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options areSMS_MFAfor text SMS MFA, andSOFTWARE_TOKEN_MFAfor TOTP software token MFA.SMS_MFA: Next challenge is to supply anSMS_MFA_CODE, delivered via SMS.PASSWORD_VERIFIER: Next challenge is to supplyPASSWORD_CLAIM_SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK, andTIMESTAMPafter the client-side SRP calculations.CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.DEVICE_PASSWORD_VERIFIER: Similar toPASSWORD_VERIFIER, but for devices only.ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate withUSERNAMEandPASSWORDdirectly. An app client must be enabled to use this flow.NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed withNEW_PASSWORDand any other required attributes.MFA_SETUP: For users who are required to setup an MFA factor before they can sign-in. The MFA types enabled for the user pool will be listed in the challenge parametersMFA_CAN_SETUPvalue.To setup software token MFA, use the session returned here from
InitiateAuthas an input toAssociateSoftwareToken, and use the session returned byVerifySoftwareTokenas an input toRespondToAuthChallengewith challenge nameMFA_SETUPto complete sign-in. To setup SMS MFA, users will need help from an administrator to add a phone number to their account and then callInitiateAuthagain to restart sign-in.
$sel:challengeParameters:AdminInitiateAuthResponse', adminInitiateAuthResponse_challengeParameters - The challenge parameters. These are returned to you in the
AdminInitiateAuth response if you need to pass another challenge. The
responses in this parameter should be used to compute inputs to the next
call (AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The value of the USER_ID_FOR_SRP attribute will be the user's actual
username, not an alias (such as email address or phone number), even if
you specified an alias in your call to AdminInitiateAuth. This is
because, in the AdminRespondToAuthChallenge API ChallengeResponses,
the USERNAME attribute cannot be an alias.
$sel:authenticationResult:AdminInitiateAuthResponse', adminInitiateAuthResponse_authenticationResult - The result of the authentication response. This is only returned if the
caller does not need to pass another challenge. If the caller does need
to pass another challenge before it gets tokens, ChallengeName,
ChallengeParameters, and Session are returned.
$sel:session:AdminInitiateAuthResponse', adminInitiateAuthResponse_session - The session which should be passed both ways in challenge-response calls
to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge
API call determines that the caller needs to go through another
challenge, they return a session with other challenge parameters. This
session should be passed as it is to the next
AdminRespondToAuthChallenge API call.
$sel:httpStatus:AdminInitiateAuthResponse', adminInitiateAuthResponse_httpStatus - The response's http status code.
AdminLinkProviderForUser
data AdminLinkProviderForUser Source #
See: newAdminLinkProviderForUser smart constructor.
Instances
newAdminLinkProviderForUser Source #
Arguments
| :: Text | |
| -> ProviderUserIdentifierType | |
| -> ProviderUserIdentifierType | |
| -> AdminLinkProviderForUser |
Create a value of AdminLinkProviderForUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminLinkProviderForUser', adminLinkProviderForUser_userPoolId - The user pool ID for the user pool.
$sel:destinationUser:AdminLinkProviderForUser', adminLinkProviderForUser_destinationUser - The existing user in the user pool to be linked to the external identity
provider user account. Can be a native (Username + Password) Cognito
User Pools user or a federated user (for example, a SAML or Facebook
user). If the user doesn't exist, an exception is thrown. This is the
user that is returned when the new user (with the linked identity
provider attribute) signs in.
For a native username + password user, the ProviderAttributeValue for
the DestinationUser should be the username in the user pool. For a
federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is ignored.
The ProviderName should be set to Cognito for users in Cognito user
pools.
$sel:sourceUser:AdminLinkProviderForUser', adminLinkProviderForUser_sourceUser - An external identity provider account for a user who does not currently
exist yet in the user pool. This user must be a federated user (for
example, a SAML or Facebook user), not another native user.
If the SourceUser is a federated social identity provider user
(Facebook, Google, or Login with Amazon), you must set the
ProviderAttributeName to Cognito_Subject. For social identity
providers, the ProviderName will be Facebook, Google, or
LoginWithAmazon, and Cognito will automatically parse the Facebook,
Google, and Login with Amazon tokens for id, sub, and user_id,
respectively. The ProviderAttributeValue for the user must be the same
value as the id, sub, or user_id value found in the social
identity provider token.
For SAML, the ProviderAttributeName can be any value that matches a
claim in the SAML assertion. If you wish to link SAML users based on the
subject of the SAML assertion, you should map the subject to a claim
through the SAML identity provider and submit that claim name as the
ProviderAttributeName. If you set ProviderAttributeName to
Cognito_Subject, Cognito will automatically parse the default unique
identifier found in the subject from the SAML token.
data AdminLinkProviderForUserResponse Source #
See: newAdminLinkProviderForUserResponse smart constructor.
Constructors
| AdminLinkProviderForUserResponse' Int |
Instances
newAdminLinkProviderForUserResponse Source #
Create a value of AdminLinkProviderForUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminLinkProviderForUserResponse', adminLinkProviderForUserResponse_httpStatus - The response's http status code.
AdminEnableUser
data AdminEnableUser Source #
Represents the request that enables the user as an administrator.
See: newAdminEnableUser smart constructor.
Constructors
| AdminEnableUser' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AdminEnableUser |
Create a value of AdminEnableUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminEnableUser', adminEnableUser_userPoolId - The user pool ID for the user pool where you want to enable the user.
$sel:username:AdminEnableUser', adminEnableUser_username - The user name of the user you wish to enable.
data AdminEnableUserResponse Source #
Represents the response from the server for the request to enable a user as an administrator.
See: newAdminEnableUserResponse smart constructor.
Constructors
| AdminEnableUserResponse' Int |
Instances
newAdminEnableUserResponse Source #
Create a value of AdminEnableUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminEnableUserResponse', adminEnableUserResponse_httpStatus - The response's http status code.
GetUserAttributeVerificationCode
data GetUserAttributeVerificationCode Source #
Represents the request to get user attribute verification.
See: newGetUserAttributeVerificationCode smart constructor.
Instances
newGetUserAttributeVerificationCode Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetUserAttributeVerificationCode |
Create a value of GetUserAttributeVerificationCode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:GetUserAttributeVerificationCode', getUserAttributeVerificationCode_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the GetUserAttributeVerificationCode API action,
Amazon Cognito invokes the function that is assigned to the /custom
message/ trigger. When Amazon Cognito invokes this function, it passes a
JSON payload, which the function receives as input. This payload
contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your
GetUserAttributeVerificationCode request. In your function code in
Lambda, you can process the clientMetadata value to enhance your
workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:accessToken:GetUserAttributeVerificationCode', getUserAttributeVerificationCode_accessToken - The access token returned by the server response to get the user
attribute verification code.
$sel:attributeName:GetUserAttributeVerificationCode', getUserAttributeVerificationCode_attributeName - The attribute name returned by the server response to get the user
attribute verification code.
data GetUserAttributeVerificationCodeResponse Source #
The verification code response returned by the server response to get the user attribute verification code.
See: newGetUserAttributeVerificationCodeResponse smart constructor.
Instances
newGetUserAttributeVerificationCodeResponse Source #
Arguments
| :: Int | |
| -> GetUserAttributeVerificationCodeResponse |
Create a value of GetUserAttributeVerificationCodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeDeliveryDetails:GetUserAttributeVerificationCodeResponse', getUserAttributeVerificationCodeResponse_codeDeliveryDetails - The code delivery details returned by the server in response to the
request to get the user attribute verification code.
$sel:httpStatus:GetUserAttributeVerificationCodeResponse', getUserAttributeVerificationCodeResponse_httpStatus - The response's http status code.
SetUserPoolMfaConfig
data SetUserPoolMfaConfig Source #
See: newSetUserPoolMfaConfig smart constructor.
Constructors
| SetUserPoolMfaConfig' (Maybe SmsMfaConfigType) (Maybe SoftwareTokenMfaConfigType) (Maybe UserPoolMfaType) Text |
Instances
newSetUserPoolMfaConfig Source #
Create a value of SetUserPoolMfaConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:smsMfaConfiguration:SetUserPoolMfaConfig', setUserPoolMfaConfig_smsMfaConfiguration - The SMS text message MFA configuration.
$sel:softwareTokenMfaConfiguration:SetUserPoolMfaConfig', setUserPoolMfaConfig_softwareTokenMfaConfiguration - The software token MFA configuration.
$sel:mfaConfiguration:SetUserPoolMfaConfig', setUserPoolMfaConfig_mfaConfiguration - The MFA configuration. Users who don't have an MFA factor set up won't
be able to sign-in if you set the MfaConfiguration value to ‘ON’. See
Adding Multi-Factor Authentication (MFA) to a User Pool
to learn more. Valid values include:
OFFMFA will not be used for any users.ONMFA is required for all users to sign in.OPTIONALMFA will be required only for individual users who have an MFA factor enabled.
$sel:userPoolId:SetUserPoolMfaConfig', setUserPoolMfaConfig_userPoolId - The user pool ID.
data SetUserPoolMfaConfigResponse Source #
See: newSetUserPoolMfaConfigResponse smart constructor.
Constructors
| SetUserPoolMfaConfigResponse' (Maybe SmsMfaConfigType) (Maybe SoftwareTokenMfaConfigType) (Maybe UserPoolMfaType) Int |
Instances
newSetUserPoolMfaConfigResponse Source #
Create a value of SetUserPoolMfaConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:smsMfaConfiguration:SetUserPoolMfaConfig', setUserPoolMfaConfigResponse_smsMfaConfiguration - The SMS text message MFA configuration.
$sel:softwareTokenMfaConfiguration:SetUserPoolMfaConfig', setUserPoolMfaConfigResponse_softwareTokenMfaConfiguration - The software token MFA configuration.
$sel:mfaConfiguration:SetUserPoolMfaConfig', setUserPoolMfaConfigResponse_mfaConfiguration - The MFA configuration. Valid values include:
OFFMFA will not be used for any users.ONMFA is required for all users to sign in.OPTIONALMFA will be required only for individual users who have an MFA factor enabled.
$sel:httpStatus:SetUserPoolMfaConfigResponse', setUserPoolMfaConfigResponse_httpStatus - The response's http status code.
UpdateUserAttributes
data UpdateUserAttributes Source #
Represents the request to update user attributes.
See: newUpdateUserAttributes smart constructor.
Constructors
| UpdateUserAttributes' (Maybe (HashMap Text Text)) [AttributeType] (Sensitive Text) |
Instances
newUpdateUserAttributes Source #
Create a value of UpdateUserAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:UpdateUserAttributes', updateUserAttributes_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the UpdateUserAttributes API action, Amazon
Cognito invokes the function that is assigned to the custom message
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your UpdateUserAttributes request. In
your function code in Lambda, you can process the clientMetadata value
to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:userAttributes:UpdateUserAttributes', updateUserAttributes_userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
$sel:accessToken:UpdateUserAttributes', updateUserAttributes_accessToken - The access token for the request to update user attributes.
data UpdateUserAttributesResponse Source #
Represents the response from the server for the request to update user attributes.
See: newUpdateUserAttributesResponse smart constructor.
Constructors
| UpdateUserAttributesResponse' (Maybe [CodeDeliveryDetailsType]) Int |
Instances
newUpdateUserAttributesResponse Source #
Create a value of UpdateUserAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeDeliveryDetailsList:UpdateUserAttributesResponse', updateUserAttributesResponse_codeDeliveryDetailsList - The code delivery details list from the server for the request to update
user attributes.
$sel:httpStatus:UpdateUserAttributesResponse', updateUserAttributesResponse_httpStatus - The response's http status code.
DeleteUserAttributes
data DeleteUserAttributes Source #
Represents the request to delete user attributes.
See: newDeleteUserAttributes smart constructor.
Constructors
| DeleteUserAttributes' [Text] (Sensitive Text) |
Instances
newDeleteUserAttributes Source #
Create a value of DeleteUserAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userAttributeNames:DeleteUserAttributes', deleteUserAttributes_userAttributeNames - An array of strings representing the user attribute names you wish to
delete.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
$sel:accessToken:DeleteUserAttributes', deleteUserAttributes_accessToken - The access token used in the request to delete user attributes.
data DeleteUserAttributesResponse Source #
Represents the response from the server to delete user attributes.
See: newDeleteUserAttributesResponse smart constructor.
Constructors
| DeleteUserAttributesResponse' Int |
Instances
newDeleteUserAttributesResponse Source #
Create a value of DeleteUserAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUserAttributesResponse', deleteUserAttributesResponse_httpStatus - The response's http status code.
VerifyUserAttribute
data VerifyUserAttribute Source #
Represents the request to verify user attributes.
See: newVerifyUserAttribute smart constructor.
Constructors
| VerifyUserAttribute' (Sensitive Text) Text Text |
Instances
newVerifyUserAttribute Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> VerifyUserAttribute |
Create a value of VerifyUserAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:VerifyUserAttribute', verifyUserAttribute_accessToken - Represents the access token of the request to verify user attributes.
$sel:attributeName:VerifyUserAttribute', verifyUserAttribute_attributeName - The attribute name in the request to verify user attributes.
$sel:code:VerifyUserAttribute', verifyUserAttribute_code - The verification code in the request to verify user attributes.
data VerifyUserAttributeResponse Source #
A container representing the response from the server from the request to verify user attributes.
See: newVerifyUserAttributeResponse smart constructor.
Constructors
| VerifyUserAttributeResponse' Int |
Instances
newVerifyUserAttributeResponse Source #
Create a value of VerifyUserAttributeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:VerifyUserAttributeResponse', verifyUserAttributeResponse_httpStatus - The response's http status code.
AdminDisableUser
data AdminDisableUser Source #
Represents the request to disable the user as an administrator.
See: newAdminDisableUser smart constructor.
Constructors
| AdminDisableUser' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AdminDisableUser |
Create a value of AdminDisableUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminDisableUser', adminDisableUser_userPoolId - The user pool ID for the user pool where you want to disable the user.
$sel:username:AdminDisableUser', adminDisableUser_username - The user name of the user you wish to disable.
data AdminDisableUserResponse Source #
Represents the response received from the server to disable the user as an administrator.
See: newAdminDisableUserResponse smart constructor.
Constructors
| AdminDisableUserResponse' Int |
Instances
newAdminDisableUserResponse Source #
Create a value of AdminDisableUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminDisableUserResponse', adminDisableUserResponse_httpStatus - The response's http status code.
ConfirmDevice
data ConfirmDevice Source #
Confirms the device request.
See: newConfirmDevice smart constructor.
Constructors
| ConfirmDevice' (Maybe DeviceSecretVerifierConfigType) (Maybe Text) (Sensitive Text) Text |
Instances
Create a value of ConfirmDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceSecretVerifierConfig:ConfirmDevice', confirmDevice_deviceSecretVerifierConfig - The configuration of the device secret verifier.
$sel:deviceName:ConfirmDevice', confirmDevice_deviceName - The device name.
$sel:accessToken:ConfirmDevice', confirmDevice_accessToken - The access token.
$sel:deviceKey:ConfirmDevice', confirmDevice_deviceKey - The device key.
data ConfirmDeviceResponse Source #
Confirms the device response.
See: newConfirmDeviceResponse smart constructor.
Constructors
| ConfirmDeviceResponse' (Maybe Bool) Int |
Instances
newConfirmDeviceResponse Source #
Create a value of ConfirmDeviceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userConfirmationNecessary:ConfirmDeviceResponse', confirmDeviceResponse_userConfirmationNecessary - Indicates whether the user confirmation is necessary to confirm the
device response.
$sel:httpStatus:ConfirmDeviceResponse', confirmDeviceResponse_httpStatus - The response's http status code.
ConfirmForgotPassword
data ConfirmForgotPassword Source #
The request representing the confirmation for a password reset.
See: newConfirmForgotPassword smart constructor.
Constructors
| ConfirmForgotPassword' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text) Text (Sensitive Text) |
Instances
newConfirmForgotPassword Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ConfirmForgotPassword |
Create a value of ConfirmForgotPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:ConfirmForgotPassword', confirmForgotPassword_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the ConfirmForgotPassword API action, Amazon
Cognito invokes the function that is assigned to the post confirmation
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your ConfirmForgotPassword request. In
your function code in Lambda, you can process the clientMetadata value
to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:analyticsMetadata:ConfirmForgotPassword', confirmForgotPassword_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls.
$sel:userContextData:ConfirmForgotPassword', confirmForgotPassword_userContextData - 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.
$sel:secretHash:ConfirmForgotPassword', confirmForgotPassword_secretHash - A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
$sel:clientId:ConfirmForgotPassword', confirmForgotPassword_clientId - The app client ID of the app associated with the user pool.
$sel:username:ConfirmForgotPassword', confirmForgotPassword_username - The user name of the user for whom you want to enter a code to retrieve
a forgotten password.
$sel:confirmationCode:ConfirmForgotPassword', confirmForgotPassword_confirmationCode - The confirmation code sent by a user's request to retrieve a forgotten
password. For more information, see
ForgotPassword.
$sel:password:ConfirmForgotPassword', confirmForgotPassword_password - The password sent by a user's request to retrieve a forgotten password.
data ConfirmForgotPasswordResponse Source #
The response from the server that results from a user's request to retrieve a forgotten password.
See: newConfirmForgotPasswordResponse smart constructor.
Constructors
| ConfirmForgotPasswordResponse' Int |
Instances
newConfirmForgotPasswordResponse Source #
Create a value of ConfirmForgotPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ConfirmForgotPasswordResponse', confirmForgotPasswordResponse_httpStatus - The response's http status code.
ListUserImportJobs
data ListUserImportJobs Source #
Represents the request to list the user import jobs.
See: newListUserImportJobs smart constructor.
Constructors
| ListUserImportJobs' (Maybe Text) Text Natural |
Instances
newListUserImportJobs Source #
Arguments
| :: Text | |
| -> Natural | |
| -> ListUserImportJobs |
Create a value of ListUserImportJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:ListUserImportJobs', listUserImportJobs_paginationToken - An identifier that was returned from the previous call to
ListUserImportJobs, which can be used to return the next set of import
jobs in the list.
$sel:userPoolId:ListUserImportJobs', listUserImportJobs_userPoolId - The user pool ID for the user pool that the users are being imported
into.
$sel:maxResults:ListUserImportJobs', listUserImportJobs_maxResults - The maximum number of import jobs you want the request to return.
data ListUserImportJobsResponse Source #
Represents the response from the server to the request to list the user import jobs.
See: newListUserImportJobsResponse smart constructor.
Constructors
| ListUserImportJobsResponse' (Maybe Text) (Maybe (NonEmpty UserImportJobType)) Int |
Instances
newListUserImportJobsResponse Source #
Create a value of ListUserImportJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:ListUserImportJobs', listUserImportJobsResponse_paginationToken - An identifier that can be used to return the next set of user import
jobs in the list.
$sel:userImportJobs:ListUserImportJobsResponse', listUserImportJobsResponse_userImportJobs - The user import jobs.
$sel:httpStatus:ListUserImportJobsResponse', listUserImportJobsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the user pool that the tags are
assigned to.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags that are assigned to the user pool.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
DescribeIdentityProvider
data DescribeIdentityProvider Source #
See: newDescribeIdentityProvider smart constructor.
Constructors
| DescribeIdentityProvider' Text Text |
Instances
newDescribeIdentityProvider Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeIdentityProvider |
Create a value of DescribeIdentityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DescribeIdentityProvider', describeIdentityProvider_userPoolId - The user pool ID.
$sel:providerName:DescribeIdentityProvider', describeIdentityProvider_providerName - The identity provider name.
data DescribeIdentityProviderResponse Source #
See: newDescribeIdentityProviderResponse smart constructor.
Constructors
| DescribeIdentityProviderResponse' Int IdentityProviderType |
Instances
newDescribeIdentityProviderResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderType | |
| -> DescribeIdentityProviderResponse |
Create a value of DescribeIdentityProviderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeIdentityProviderResponse', describeIdentityProviderResponse_httpStatus - The response's http status code.
$sel:identityProvider:DescribeIdentityProviderResponse', describeIdentityProviderResponse_identityProvider - The identity provider that was deleted.
ListUsers (Paginated)
Represents the request to list users.
See: newListUsers smart constructor.
Instances
Create a value of ListUsers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:ListUsers', listUsers_paginationToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:attributesToGet:ListUsers', listUsers_attributesToGet - An array of strings, where each string is the name of a user attribute
to be returned for each user in the search results. If the array is
null, all attributes are returned.
$sel:limit:ListUsers', listUsers_limit - Maximum number of users to be returned.
$sel:filter':ListUsers', listUsers_filter - A filter string of the form "AttributeName Filter-Type
"AttributeValue"". Quotation marks within the filter string must be
escaped using the backslash (\) character. For example, "family_name
= \"Reddy\"".
- AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
- Filter-Type: For an exact match, use =, for example,
"
given_name= \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name^= \"Jon\"". - AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers returns all users in the user
pool.
You can only search for the following standard attributes:
username(case-sensitive)email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status(called Status in the Console) (case-insensitive)status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
$sel:userPoolId:ListUsers', listUsers_userPoolId - The user pool ID for the user pool on which the search should be
performed.
data ListUsersResponse Source #
The response from the request to list users.
See: newListUsersResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListUsersResponse |
Create a value of ListUsersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:ListUsers', listUsersResponse_paginationToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:users:ListUsersResponse', listUsersResponse_users - The users returned in the request to list users.
$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.
AdminDeleteUserAttributes
data AdminDeleteUserAttributes Source #
Represents the request to delete user attributes as an administrator.
See: newAdminDeleteUserAttributes smart constructor.
Constructors
| AdminDeleteUserAttributes' Text (Sensitive Text) [Text] |
Instances
newAdminDeleteUserAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminDeleteUserAttributes |
Create a value of AdminDeleteUserAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminDeleteUserAttributes', adminDeleteUserAttributes_userPoolId - The user pool ID for the user pool where you want to delete user
attributes.
$sel:username:AdminDeleteUserAttributes', adminDeleteUserAttributes_username - The user name of the user from which you would like to delete
attributes.
$sel:userAttributeNames:AdminDeleteUserAttributes', adminDeleteUserAttributes_userAttributeNames - An array of strings representing the user attribute names you wish to
delete.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
data AdminDeleteUserAttributesResponse Source #
Represents the response received from the server for a request to delete user attributes.
See: newAdminDeleteUserAttributesResponse smart constructor.
Constructors
| AdminDeleteUserAttributesResponse' Int |
Instances
newAdminDeleteUserAttributesResponse Source #
Arguments
| :: Int | |
| -> AdminDeleteUserAttributesResponse |
Create a value of AdminDeleteUserAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminDeleteUserAttributesResponse', adminDeleteUserAttributesResponse_httpStatus - The response's http status code.
DescribeUserPoolDomain
data DescribeUserPoolDomain Source #
See: newDescribeUserPoolDomain smart constructor.
Constructors
| DescribeUserPoolDomain' Text |
Instances
newDescribeUserPoolDomain Source #
Create a value of DescribeUserPoolDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:DescribeUserPoolDomain', describeUserPoolDomain_domain - The domain string.
data DescribeUserPoolDomainResponse Source #
See: newDescribeUserPoolDomainResponse smart constructor.
Constructors
| DescribeUserPoolDomainResponse' (Maybe DomainDescriptionType) Int |
Instances
newDescribeUserPoolDomainResponse Source #
Create a value of DescribeUserPoolDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainDescription:DescribeUserPoolDomainResponse', describeUserPoolDomainResponse_domainDescription - A domain description object containing information about the domain.
$sel:httpStatus:DescribeUserPoolDomainResponse', describeUserPoolDomainResponse_httpStatus - The response's http status code.
AdminUpdateUserAttributes
data AdminUpdateUserAttributes Source #
Represents the request to update the user's attributes as an administrator.
See: newAdminUpdateUserAttributes smart constructor.
Constructors
| AdminUpdateUserAttributes' (Maybe (HashMap Text Text)) Text (Sensitive Text) [AttributeType] |
Instances
newAdminUpdateUserAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminUpdateUserAttributes |
Create a value of AdminUpdateUserAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminUpdateUserAttributes', adminUpdateUserAttributes_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminUpdateUserAttributes API action, Amazon
Cognito invokes the function that is assigned to the custom message
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your AdminUpdateUserAttributes request.
In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:userPoolId:AdminUpdateUserAttributes', adminUpdateUserAttributes_userPoolId - The user pool ID for the user pool where you want to update user
attributes.
$sel:username:AdminUpdateUserAttributes', adminUpdateUserAttributes_username - The user name of the user for whom you want to update user attributes.
$sel:userAttributes:AdminUpdateUserAttributes', adminUpdateUserAttributes_userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
data AdminUpdateUserAttributesResponse Source #
Represents the response from the server for the request to update user attributes as an administrator.
See: newAdminUpdateUserAttributesResponse smart constructor.
Constructors
| AdminUpdateUserAttributesResponse' Int |
Instances
newAdminUpdateUserAttributesResponse Source #
Arguments
| :: Int | |
| -> AdminUpdateUserAttributesResponse |
Create a value of AdminUpdateUserAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminUpdateUserAttributesResponse', adminUpdateUserAttributesResponse_httpStatus - The response's http status code.
AdminGetUser
data AdminGetUser Source #
Represents the request to get the specified user as an administrator.
See: newAdminGetUser smart constructor.
Constructors
| AdminGetUser' Text (Sensitive Text) |
Instances
Create a value of AdminGetUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminGetUser', adminGetUser_userPoolId - The user pool ID for the user pool where you want to get information
about the user.
$sel:username:AdminGetUser', adminGetUser_username - The user name of the user you wish to retrieve.
data AdminGetUserResponse Source #
Represents the response from the server from the request to get the specified user as an administrator.
See: newAdminGetUserResponse smart constructor.
Constructors
| AdminGetUserResponse' (Maybe Bool) (Maybe UserStatusType) (Maybe [AttributeType]) (Maybe POSIX) (Maybe [Text]) (Maybe [MFAOptionType]) (Maybe POSIX) (Maybe Text) Int (Sensitive Text) |
Instances
newAdminGetUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> AdminGetUserResponse |
Create a value of AdminGetUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:AdminGetUserResponse', adminGetUserResponse_enabled - Indicates that the status is enabled.
$sel:userStatus:AdminGetUserResponse', adminGetUserResponse_userStatus - 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.
- RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
- FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
$sel:userAttributes:AdminGetUserResponse', adminGetUserResponse_userAttributes - An array of name-value pairs representing user attributes.
$sel:userCreateDate:AdminGetUserResponse', adminGetUserResponse_userCreateDate - The date the user was created.
$sel:userMFASettingList:AdminGetUserResponse', adminGetUserResponse_userMFASettingList - The MFA options that are enabled for the user. The possible values in
this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
$sel:mfaOptions:AdminGetUserResponse', adminGetUserResponse_mfaOptions - This response parameter is no longer supported. It provides
information only about SMS MFA configurations. It doesn't provide
information about TOTP software token MFA configurations. To look up
information about either type of MFA configuration, use
UserMFASettingList instead.
$sel:userLastModifiedDate:AdminGetUserResponse', adminGetUserResponse_userLastModifiedDate - The date the user was last modified.
$sel:preferredMfaSetting:AdminGetUserResponse', adminGetUserResponse_preferredMfaSetting - The user's preferred MFA setting.
$sel:httpStatus:AdminGetUserResponse', adminGetUserResponse_httpStatus - The response's http status code.
$sel:username:AdminGetUser', adminGetUserResponse_username - The user name of the user about whom you are receiving information.
AdminUserGlobalSignOut
data AdminUserGlobalSignOut Source #
The request to sign out of all devices, as an administrator.
See: newAdminUserGlobalSignOut smart constructor.
Constructors
| AdminUserGlobalSignOut' Text (Sensitive Text) |
Instances
newAdminUserGlobalSignOut Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminUserGlobalSignOut |
Create a value of AdminUserGlobalSignOut with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminUserGlobalSignOut', adminUserGlobalSignOut_userPoolId - The user pool ID.
$sel:username:AdminUserGlobalSignOut', adminUserGlobalSignOut_username - The user name.
data AdminUserGlobalSignOutResponse Source #
The global sign-out response, as an administrator.
See: newAdminUserGlobalSignOutResponse smart constructor.
Constructors
| AdminUserGlobalSignOutResponse' Int |
Instances
newAdminUserGlobalSignOutResponse Source #
Create a value of AdminUserGlobalSignOutResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminUserGlobalSignOutResponse', adminUserGlobalSignOutResponse_httpStatus - The response's http status code.
ListUsersInGroup (Paginated)
data ListUsersInGroup Source #
See: newListUsersInGroup smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListUsersInGroup |
Create a value of ListUsersInGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListUsersInGroup', listUsersInGroup_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:limit:ListUsersInGroup', listUsersInGroup_limit - The limit of the request to list users.
$sel:userPoolId:ListUsersInGroup', listUsersInGroup_userPoolId - The user pool ID for the user pool.
$sel:groupName:ListUsersInGroup', listUsersInGroup_groupName - The name of the group.
data ListUsersInGroupResponse Source #
See: newListUsersInGroupResponse smart constructor.
Instances
newListUsersInGroupResponse Source #
Create a value of ListUsersInGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:users:ListUsersInGroupResponse', listUsersInGroupResponse_users - The users returned in the request to list users.
$sel:nextToken:ListUsersInGroup', listUsersInGroupResponse_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:httpStatus:ListUsersInGroupResponse', listUsersInGroupResponse_httpStatus - The response's http status code.
AssociateSoftwareToken
data AssociateSoftwareToken Source #
See: newAssociateSoftwareToken smart constructor.
Instances
newAssociateSoftwareToken :: AssociateSoftwareToken Source #
Create a value of AssociateSoftwareToken with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:AssociateSoftwareToken', associateSoftwareToken_accessToken - The access token.
$sel:session:AssociateSoftwareToken', associateSoftwareToken_session - The session which should be passed both ways in challenge-response calls
to the service. This allows authentication of the user as part of the
MFA setup process.
data AssociateSoftwareTokenResponse Source #
See: newAssociateSoftwareTokenResponse smart constructor.
Instances
newAssociateSoftwareTokenResponse Source #
Create a value of AssociateSoftwareTokenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secretCode:AssociateSoftwareTokenResponse', associateSoftwareTokenResponse_secretCode - A unique generated shared secret code that is used in the TOTP algorithm
to generate a one time code.
$sel:session:AssociateSoftwareToken', associateSoftwareTokenResponse_session - The session which should be passed both ways in challenge-response calls
to the service. This allows authentication of the user as part of the
MFA setup process.
$sel:httpStatus:AssociateSoftwareTokenResponse', associateSoftwareTokenResponse_httpStatus - The response's http status code.
AdminDisableProviderForUser
data AdminDisableProviderForUser Source #
See: newAdminDisableProviderForUser smart constructor.
Instances
newAdminDisableProviderForUser Source #
Arguments
| :: Text | |
| -> ProviderUserIdentifierType | |
| -> AdminDisableProviderForUser |
Create a value of AdminDisableProviderForUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminDisableProviderForUser', adminDisableProviderForUser_userPoolId - The user pool ID for the user pool.
$sel:user:AdminDisableProviderForUser', adminDisableProviderForUser_user - The user to be disabled.
data AdminDisableProviderForUserResponse Source #
See: newAdminDisableProviderForUserResponse smart constructor.
Constructors
| AdminDisableProviderForUserResponse' Int |
Instances
newAdminDisableProviderForUserResponse Source #
Arguments
| :: Int | |
| -> AdminDisableProviderForUserResponse |
Create a value of AdminDisableProviderForUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminDisableProviderForUserResponse', adminDisableProviderForUserResponse_httpStatus - The response's http status code.
ForgotPassword
data ForgotPassword Source #
Represents the request to reset a user's password.
See: newForgotPassword smart constructor.
Constructors
| ForgotPassword' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text) |
Instances
Create a value of ForgotPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:ForgotPassword', forgotPassword_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the ForgotPassword API action, Amazon Cognito
invokes any functions that are assigned to the following triggers: /pre
sign-up, custom message, and user migration/. When Amazon Cognito
invokes any of these functions, it passes a JSON payload, which the
function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the
ClientMetadata parameter in your ForgotPassword request. In your
function code in Lambda, you can process the clientMetadata value to
enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:analyticsMetadata:ForgotPassword', forgotPassword_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
ForgotPassword calls.
$sel:userContextData:ForgotPassword', forgotPassword_userContextData - 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.
$sel:secretHash:ForgotPassword', forgotPassword_secretHash - A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
$sel:clientId:ForgotPassword', forgotPassword_clientId - The ID of the client associated with the user pool.
$sel:username:ForgotPassword', forgotPassword_username - The user name of the user for whom you want to enter a code to reset a
forgotten password.
data ForgotPasswordResponse Source #
Respresents the response from the server regarding the request to reset a password.
See: newForgotPasswordResponse smart constructor.
Constructors
| ForgotPasswordResponse' (Maybe CodeDeliveryDetailsType) Int |
Instances
newForgotPasswordResponse Source #
Create a value of ForgotPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeDeliveryDetails:ForgotPasswordResponse', forgotPasswordResponse_codeDeliveryDetails - The code delivery details returned by the server in response to the
request to reset a password.
$sel:httpStatus:ForgotPasswordResponse', forgotPasswordResponse_httpStatus - The response's http status code.
DescribeUserPool
data DescribeUserPool Source #
Represents the request to describe the user pool.
See: newDescribeUserPool smart constructor.
Constructors
| DescribeUserPool' Text |
Instances
Arguments
| :: Text | |
| -> DescribeUserPool |
Create a value of DescribeUserPool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DescribeUserPool', describeUserPool_userPoolId - The user pool ID for the user pool you want to describe.
data DescribeUserPoolResponse Source #
Represents the response to describe the user pool.
See: newDescribeUserPoolResponse smart constructor.
Constructors
| DescribeUserPoolResponse' (Maybe UserPoolType) Int |
Instances
newDescribeUserPoolResponse Source #
Create a value of DescribeUserPoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPool:DescribeUserPoolResponse', describeUserPoolResponse_userPool - The container of metadata returned by the server to describe the pool.
$sel:httpStatus:DescribeUserPoolResponse', describeUserPoolResponse_httpStatus - The response's http status code.
InitiateAuth
data InitiateAuth Source #
Initiates the authentication request.
See: newInitiateAuth smart constructor.
Constructors
| InitiateAuth' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive (HashMap Text Text))) AuthFlowType (Sensitive Text) |
Instances
Arguments
| :: AuthFlowType | |
| -> Text | |
| -> InitiateAuth |
Create a value of InitiateAuth with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:InitiateAuth', initiateAuth_clientMetadata - A map of custom key-value pairs that you can provide as input for
certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
- Pre signup
- Pre authentication
- User migration
When Amazon Cognito invokes the functions for these triggers, it passes
a JSON payload, which the function receives as input. This payload
contains a validationData attribute, which provides the data that you
assigned to the ClientMetadata parameter in your InitiateAuth request.
In your function code in Lambda, you can process the validationData
value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Verify auth challenge
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:analyticsMetadata:InitiateAuth', initiateAuth_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
InitiateAuth calls.
$sel:userContextData:InitiateAuth', initiateAuth_userContextData - 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.
$sel:authParameters:InitiateAuth', initiateAuth_authParameters - The authentication parameters. These are inputs corresponding to the
AuthFlow that you are invoking. The required values depend on the
value of AuthFlow:
- For
USER_SRP_AUTH:USERNAME(required),SRP_A(required),SECRET_HASH(required if the app client is configured with a client secret),DEVICE_KEY. - For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN:REFRESH_TOKEN(required),SECRET_HASH(required if the app client is configured with a client secret),DEVICE_KEY. - For
CUSTOM_AUTH:USERNAME(required),SECRET_HASH(if app client is configured with client secret),DEVICE_KEY. To start the authentication flow with password verification, includeChallengeName: SRP_AandSRP_A: (The SRP_A Value).
$sel:authFlow:InitiateAuth', initiateAuth_authFlow - The authentication flow for this call to execute. The API action will
depend on this value. For example:
REFRESH_TOKEN_AUTHwill take in a valid refresh token and return new tokens.USER_SRP_AUTHwill take inUSERNAMEandSRP_Aand return the SRP variables to be used for next challenge execution.USER_PASSWORD_AUTHwill take inUSERNAMEandPASSWORDand return the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.CUSTOM_AUTH: Custom authentication flow.USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces theADMIN_NO_SRP_AUTHauthentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
ADMIN_NO_SRP_AUTH is not a valid value.
$sel:clientId:InitiateAuth', initiateAuth_clientId - The app client ID.
data InitiateAuthResponse Source #
Initiates the authentication response.
See: newInitiateAuthResponse smart constructor.
Constructors
| InitiateAuthResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int |
Instances
newInitiateAuthResponse Source #
Arguments
| :: Int | |
| -> InitiateAuthResponse |
Create a value of InitiateAuthResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:challengeName:InitiateAuthResponse', initiateAuthResponse_challengeName - The name of the challenge which you are responding to with this call.
This is returned to you in the AdminInitiateAuth response if you need
to pass another challenge.
Valid values include the following. Note that all of these challenges
require USERNAME and SECRET_HASH (if applicable) in the parameters.
SMS_MFA: Next challenge is to supply anSMS_MFA_CODE, delivered via SMS.PASSWORD_VERIFIER: Next challenge is to supplyPASSWORD_CLAIM_SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK, andTIMESTAMPafter the client-side SRP calculations.CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.DEVICE_PASSWORD_VERIFIER: Similar toPASSWORD_VERIFIER, but for devices only.NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed withNEW_PASSWORDand any other required attributes.MFA_SETUP: For users who are required to setup an MFA factor before they can sign-in. The MFA types enabled for the user pool will be listed in the challenge parametersMFA_CAN_SETUPvalue.To setup software token MFA, use the session returned here from
InitiateAuthas an input toAssociateSoftwareToken, and use the session returned byVerifySoftwareTokenas an input toRespondToAuthChallengewith challenge nameMFA_SETUPto complete sign-in. To setup SMS MFA, users will need help from an administrator to add a phone number to their account and then callInitiateAuthagain to restart sign-in.
$sel:challengeParameters:InitiateAuthResponse', initiateAuthResponse_challengeParameters - The challenge parameters. These are returned to you in the
InitiateAuth response if you need to pass another challenge. The
responses in this parameter should be used to compute inputs to the next
call (RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
$sel:authenticationResult:InitiateAuthResponse', initiateAuthResponse_authenticationResult - The result of the authentication response. This is only returned if the
caller does not need to pass another challenge. If the caller does need
to pass another challenge before it gets tokens, ChallengeName,
ChallengeParameters, and Session are returned.
$sel:session:InitiateAuthResponse', initiateAuthResponse_session - The session which should be passed both ways in challenge-response calls
to the service. If the caller needs to go through another challenge,
they return a session with other challenge parameters. This session
should be passed as it is to the next RespondToAuthChallenge API call.
$sel:httpStatus:InitiateAuthResponse', initiateAuthResponse_httpStatus - The response's http status code.
AdminListGroupsForUser (Paginated)
data AdminListGroupsForUser Source #
See: newAdminListGroupsForUser smart constructor.
Instances
newAdminListGroupsForUser Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminListGroupsForUser |
Create a value of AdminListGroupsForUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:AdminListGroupsForUser', adminListGroupsForUser_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:limit:AdminListGroupsForUser', adminListGroupsForUser_limit - The limit of the request to list groups.
$sel:username:AdminListGroupsForUser', adminListGroupsForUser_username - The username for the user.
$sel:userPoolId:AdminListGroupsForUser', adminListGroupsForUser_userPoolId - The user pool ID for the user pool.
data AdminListGroupsForUserResponse Source #
See: newAdminListGroupsForUserResponse smart constructor.
Instances
newAdminListGroupsForUserResponse Source #
Create a value of AdminListGroupsForUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:AdminListGroupsForUserResponse', adminListGroupsForUserResponse_groups - The groups that the user belongs to.
$sel:nextToken:AdminListGroupsForUser', adminListGroupsForUserResponse_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:httpStatus:AdminListGroupsForUserResponse', adminListGroupsForUserResponse_httpStatus - The response's http status code.
AdminConfirmSignUp
data AdminConfirmSignUp Source #
Represents the request to confirm user registration.
See: newAdminConfirmSignUp smart constructor.
Instances
newAdminConfirmSignUp Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminConfirmSignUp |
Create a value of AdminConfirmSignUp with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminConfirmSignUp', adminConfirmSignUp_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
If your user pool configuration includes triggers, the
AdminConfirmSignUp API action invokes the Lambda function that is
specified for the post confirmation trigger. When Amazon Cognito
invokes this function, it passes a JSON payload, which the function
receives as input. In this payload, the clientMetadata attribute
provides the data that you assigned to the ClientMetadata parameter in
your AdminConfirmSignUp request. In your function code in Lambda, you
can process the ClientMetadata value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:userPoolId:AdminConfirmSignUp', adminConfirmSignUp_userPoolId - The user pool ID for which you want to confirm user registration.
$sel:username:AdminConfirmSignUp', adminConfirmSignUp_username - The user name for which you want to confirm user registration.
data AdminConfirmSignUpResponse Source #
Represents the response from the server for the request to confirm registration.
See: newAdminConfirmSignUpResponse smart constructor.
Constructors
| AdminConfirmSignUpResponse' Int |
Instances
newAdminConfirmSignUpResponse Source #
Create a value of AdminConfirmSignUpResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminConfirmSignUpResponse', adminConfirmSignUpResponse_httpStatus - The response's http status code.
AdminUpdateAuthEventFeedback
data AdminUpdateAuthEventFeedback Source #
See: newAdminUpdateAuthEventFeedback smart constructor.
Constructors
| AdminUpdateAuthEventFeedback' Text (Sensitive Text) Text FeedbackValueType |
Instances
newAdminUpdateAuthEventFeedback Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> FeedbackValueType | |
| -> AdminUpdateAuthEventFeedback |
Create a value of AdminUpdateAuthEventFeedback with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminUpdateAuthEventFeedback', adminUpdateAuthEventFeedback_userPoolId - The user pool ID.
$sel:username:AdminUpdateAuthEventFeedback', adminUpdateAuthEventFeedback_username - The user pool username.
$sel:eventId:AdminUpdateAuthEventFeedback', adminUpdateAuthEventFeedback_eventId - The authentication event ID.
$sel:feedbackValue:AdminUpdateAuthEventFeedback', adminUpdateAuthEventFeedback_feedbackValue - The authentication event feedback value.
data AdminUpdateAuthEventFeedbackResponse Source #
See: newAdminUpdateAuthEventFeedbackResponse smart constructor.
Constructors
| AdminUpdateAuthEventFeedbackResponse' Int |
Instances
newAdminUpdateAuthEventFeedbackResponse Source #
Arguments
| :: Int | |
| -> AdminUpdateAuthEventFeedbackResponse |
Create a value of AdminUpdateAuthEventFeedbackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminUpdateAuthEventFeedbackResponse', adminUpdateAuthEventFeedbackResponse_httpStatus - The response's http status code.
AdminSetUserPassword
data AdminSetUserPassword Source #
See: newAdminSetUserPassword smart constructor.
Instances
newAdminSetUserPassword Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AdminSetUserPassword |
Create a value of AdminSetUserPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:permanent:AdminSetUserPassword', adminSetUserPassword_permanent - True if the password is permanent, False if it is temporary.
$sel:userPoolId:AdminSetUserPassword', adminSetUserPassword_userPoolId - The user pool ID for the user pool where you want to set the user's
password.
$sel:username:AdminSetUserPassword', adminSetUserPassword_username - The user name of the user whose password you wish to set.
$sel:password:AdminSetUserPassword', adminSetUserPassword_password - The password for the user.
data AdminSetUserPasswordResponse Source #
See: newAdminSetUserPasswordResponse smart constructor.
Constructors
| AdminSetUserPasswordResponse' Int |
Instances
newAdminSetUserPasswordResponse Source #
Create a value of AdminSetUserPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminSetUserPasswordResponse', adminSetUserPasswordResponse_httpStatus - The response's http status code.
StartUserImportJob
data StartUserImportJob Source #
Represents the request to start the user import job.
See: newStartUserImportJob smart constructor.
Constructors
| StartUserImportJob' Text Text |
Instances
newStartUserImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> StartUserImportJob |
Create a value of StartUserImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:StartUserImportJob', startUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported
into.
$sel:jobId:StartUserImportJob', startUserImportJob_jobId - The job ID for the user import job.
data StartUserImportJobResponse Source #
Represents the response from the server to the request to start the user import job.
See: newStartUserImportJobResponse smart constructor.
Constructors
| StartUserImportJobResponse' (Maybe UserImportJobType) Int |
Instances
newStartUserImportJobResponse Source #
Create a value of StartUserImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userImportJob:StartUserImportJobResponse', startUserImportJobResponse_userImportJob - The job object that represents the user import job.
$sel:httpStatus:StartUserImportJobResponse', startUserImportJobResponse_httpStatus - The response's http status code.
CreateIdentityProvider
data CreateIdentityProvider Source #
See: newCreateIdentityProvider smart constructor.
Constructors
| CreateIdentityProvider' (Maybe [Text]) (Maybe (HashMap Text Text)) Text Text IdentityProviderTypeType (HashMap Text Text) |
Instances
newCreateIdentityProvider Source #
Arguments
| :: Text | |
| -> Text | |
| -> IdentityProviderTypeType | |
| -> CreateIdentityProvider |
Create a value of CreateIdentityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idpIdentifiers:CreateIdentityProvider', createIdentityProvider_idpIdentifiers - A list of identity provider identifiers.
$sel:attributeMapping:CreateIdentityProvider', createIdentityProvider_attributeMapping - A mapping of identity provider attributes to standard and custom user
pool attributes.
$sel:userPoolId:CreateIdentityProvider', createIdentityProvider_userPoolId - The user pool ID.
$sel:providerName:CreateIdentityProvider', createIdentityProvider_providerName - The identity provider name.
$sel:providerType:CreateIdentityProvider', createIdentityProvider_providerType - The identity provider type.
$sel:providerDetails:CreateIdentityProvider', createIdentityProvider_providerDetails - The identity provider details. The following list describes the provider
detail keys for each identity provider type.
For Google and Login with Amazon:
- client_id
- client_secret
- authorize_scopes
For Facebook:
- client_id
- client_secret
- authorize_scopes
- api_version
For Sign in with Apple:
- client_id
- team_id
- key_id
- private_key
- authorize_scopes
For OIDC providers:
- client_id
- client_secret
- attributes_request_method
- oidc_issuer
- authorize_scopes
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignout optional
data CreateIdentityProviderResponse Source #
See: newCreateIdentityProviderResponse smart constructor.
Constructors
| CreateIdentityProviderResponse' Int IdentityProviderType |
Instances
newCreateIdentityProviderResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderType | |
| -> CreateIdentityProviderResponse |
Create a value of CreateIdentityProviderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateIdentityProviderResponse', createIdentityProviderResponse_httpStatus - The response's http status code.
$sel:identityProvider:CreateIdentityProviderResponse', createIdentityProviderResponse_identityProvider - The newly created identity provider object.
SetUICustomization
data SetUICustomization Source #
See: newSetUICustomization smart constructor.
Instances
newSetUICustomization Source #
Arguments
| :: Text | |
| -> SetUICustomization |
Create a value of SetUICustomization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:SetUICustomization', setUICustomization_clientId - The client ID for the client app.
$sel:css:SetUICustomization', setUICustomization_css - The CSS values in the UI customization.
$sel:imageFile:SetUICustomization', setUICustomization_imageFile - The uploaded logo image for the UI customization.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:userPoolId:SetUICustomization', setUICustomization_userPoolId - The user pool ID for the user pool.
data SetUICustomizationResponse Source #
See: newSetUICustomizationResponse smart constructor.
Constructors
| SetUICustomizationResponse' Int UICustomizationType |
Instances
newSetUICustomizationResponse Source #
Arguments
| :: Int | |
| -> UICustomizationType | |
| -> SetUICustomizationResponse |
Create a value of SetUICustomizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetUICustomizationResponse', setUICustomizationResponse_httpStatus - The response's http status code.
$sel:uICustomization:SetUICustomizationResponse', setUICustomizationResponse_uICustomization - The UI customization information.
ListIdentityProviders (Paginated)
data ListIdentityProviders Source #
See: newListIdentityProviders smart constructor.
Instances
newListIdentityProviders Source #
Create a value of ListIdentityProviders with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListIdentityProviders', listIdentityProviders_nextToken - A pagination token.
$sel:maxResults:ListIdentityProviders', listIdentityProviders_maxResults - The maximum number of identity providers to return.
$sel:userPoolId:ListIdentityProviders', listIdentityProviders_userPoolId - The user pool ID.
data ListIdentityProvidersResponse Source #
See: newListIdentityProvidersResponse smart constructor.
Constructors
| ListIdentityProvidersResponse' (Maybe Text) Int [ProviderDescription] |
Instances
newListIdentityProvidersResponse Source #
Create a value of ListIdentityProvidersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListIdentityProviders', listIdentityProvidersResponse_nextToken - A pagination token.
$sel:httpStatus:ListIdentityProvidersResponse', listIdentityProvidersResponse_httpStatus - The response's http status code.
$sel:providers:ListIdentityProvidersResponse', listIdentityProvidersResponse_providers - A list of identity provider objects.
GetDevice
Represents the request to get the device.
See: newGetDevice smart constructor.
Constructors
| GetDevice' (Maybe (Sensitive Text)) Text |
Instances
Create a value of GetDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:GetDevice', getDevice_accessToken - The access token.
$sel:deviceKey:GetDevice', getDevice_deviceKey - The device key.
data GetDeviceResponse Source #
Gets the device response.
See: newGetDeviceResponse smart constructor.
Constructors
| GetDeviceResponse' Int DeviceType |
Instances
Arguments
| :: Int | |
| -> DeviceType | |
| -> GetDeviceResponse |
Create a value of GetDeviceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetDeviceResponse', getDeviceResponse_httpStatus - The response's http status code.
$sel:device:GetDeviceResponse', getDeviceResponse_device - The device.
SignUp
Represents the request to register a user.
See: newSignUp smart constructor.
Constructors
| SignUp' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe [AttributeType]) (Maybe (Sensitive Text)) (Maybe [AttributeType]) (Sensitive Text) (Sensitive Text) (Sensitive Text) |
Instances
Create a value of SignUp with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:SignUp', signUp_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the SignUp API action, Amazon Cognito invokes any
functions that are assigned to the following triggers: pre sign-up,
custom message, and post confirmation. When Amazon Cognito invokes
any of these functions, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute,
which provides the data that you assigned to the ClientMetadata
parameter in your SignUp request. In your function code in Lambda, you
can process the clientMetadata value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:analyticsMetadata:SignUp', signUp_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
SignUp calls.
$sel:userContextData:SignUp', signUp_userContextData - 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.
$sel:userAttributes:SignUp', signUp_userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
$sel:secretHash:SignUp', signUp_secretHash - A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
$sel:validationData:SignUp', signUp_validationData - The validation data in the request to register a user.
$sel:clientId:SignUp', signUp_clientId - The ID of the client associated with the user pool.
$sel:username:SignUp', signUp_username - The user name of the user you wish to register.
$sel:password:SignUp', signUp_password - The password of the user you wish to register.
data SignUpResponse Source #
The response from the server for a registration request.
See: newSignUpResponse smart constructor.
Constructors
| SignUpResponse' (Maybe CodeDeliveryDetailsType) Int Bool Text |
Instances
Arguments
| :: Int | |
| -> Bool | |
| -> Text | |
| -> SignUpResponse |
Create a value of SignUpResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeDeliveryDetails:SignUpResponse', signUpResponse_codeDeliveryDetails - The code delivery details returned by the server response to the user
registration request.
$sel:httpStatus:SignUpResponse', signUpResponse_httpStatus - The response's http status code.
$sel:userConfirmed:SignUpResponse', signUpResponse_userConfirmed - A response from the server indicating that a user registration has been
confirmed.
$sel:userSub:SignUpResponse', signUpResponse_userSub - The UUID of the authenticated user. This is not the same as username.
DeleteResourceServer
data DeleteResourceServer Source #
See: newDeleteResourceServer smart constructor.
Constructors
| DeleteResourceServer' Text Text |
Instances
newDeleteResourceServer Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteResourceServer |
Create a value of DeleteResourceServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DeleteResourceServer', deleteResourceServer_userPoolId - The user pool ID for the user pool that hosts the resource server.
$sel:identifier:DeleteResourceServer', deleteResourceServer_identifier - The identifier for the resource server.
data DeleteResourceServerResponse Source #
See: newDeleteResourceServerResponse smart constructor.
Constructors
| DeleteResourceServerResponse' | |
Instances
| Eq DeleteResourceServerResponse Source # | |
| Read DeleteResourceServerResponse Source # | |
| Show DeleteResourceServerResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteResourceServer Methods showsPrec :: Int -> DeleteResourceServerResponse -> ShowS # show :: DeleteResourceServerResponse -> String # showList :: [DeleteResourceServerResponse] -> ShowS # | |
| Generic DeleteResourceServerResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteResourceServer Associated Types type Rep DeleteResourceServerResponse :: Type -> Type # | |
| NFData DeleteResourceServerResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteResourceServer Methods rnf :: DeleteResourceServerResponse -> () # | |
| type Rep DeleteResourceServerResponse Source # | |
newDeleteResourceServerResponse :: DeleteResourceServerResponse Source #
Create a value of DeleteResourceServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateResourceServer
data UpdateResourceServer Source #
See: newUpdateResourceServer smart constructor.
Constructors
| UpdateResourceServer' (Maybe [ResourceServerScopeType]) Text Text Text |
Instances
newUpdateResourceServer Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateResourceServer |
Create a value of UpdateResourceServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scopes:UpdateResourceServer', updateResourceServer_scopes - The scope values to be set for the resource server.
$sel:userPoolId:UpdateResourceServer', updateResourceServer_userPoolId - The user pool ID for the user pool.
$sel:identifier:UpdateResourceServer', updateResourceServer_identifier - The identifier for the resource server.
$sel:name:UpdateResourceServer', updateResourceServer_name - The name of the resource server.
data UpdateResourceServerResponse Source #
See: newUpdateResourceServerResponse smart constructor.
Constructors
| UpdateResourceServerResponse' Int ResourceServerType |
Instances
newUpdateResourceServerResponse Source #
Arguments
| :: Int | |
| -> ResourceServerType | |
| -> UpdateResourceServerResponse |
Create a value of UpdateResourceServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateResourceServerResponse', updateResourceServerResponse_httpStatus - The response's http status code.
$sel:resourceServer:UpdateResourceServerResponse', updateResourceServerResponse_resourceServer - The resource server.
ChangePassword
data ChangePassword Source #
Represents the request to change a user password.
See: newChangePassword smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ChangePassword |
Create a value of ChangePassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:previousPassword:ChangePassword', changePassword_previousPassword - The old password.
$sel:proposedPassword:ChangePassword', changePassword_proposedPassword - The new password.
$sel:accessToken:ChangePassword', changePassword_accessToken - The access token.
data ChangePasswordResponse Source #
The response from the server to the change password request.
See: newChangePasswordResponse smart constructor.
Constructors
| ChangePasswordResponse' Int |
Instances
newChangePasswordResponse Source #
Create a value of ChangePasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ChangePasswordResponse', changePasswordResponse_httpStatus - The response's http status code.
CreateUserPoolDomain
data CreateUserPoolDomain Source #
See: newCreateUserPoolDomain smart constructor.
Constructors
| CreateUserPoolDomain' (Maybe CustomDomainConfigType) Text Text |
Instances
newCreateUserPoolDomain Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateUserPoolDomain |
Create a value of CreateUserPoolDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customDomainConfig:CreateUserPoolDomain', createUserPoolDomain_customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in
webpages for your application.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
$sel:domain:CreateUserPoolDomain', createUserPoolDomain_domain - The domain string.
$sel:userPoolId:CreateUserPoolDomain', createUserPoolDomain_userPoolId - The user pool ID.
data CreateUserPoolDomainResponse Source #
See: newCreateUserPoolDomainResponse smart constructor.
Constructors
| CreateUserPoolDomainResponse' (Maybe Text) Int |
Instances
newCreateUserPoolDomainResponse Source #
Create a value of CreateUserPoolDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudFrontDomain:CreateUserPoolDomainResponse', createUserPoolDomainResponse_cloudFrontDomain - The Amazon CloudFront endpoint that you use as the target of the alias
that you set up with your Domain Name Service (DNS) provider.
$sel:httpStatus:CreateUserPoolDomainResponse', createUserPoolDomainResponse_httpStatus - The response's http status code.
RespondToAuthChallenge
data RespondToAuthChallenge Source #
The request to respond to an authentication challenge.
See: newRespondToAuthChallenge smart constructor.
Constructors
| RespondToAuthChallenge' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe (HashMap Text Text)) (Maybe UserContextDataType) (Maybe Text) (Sensitive Text) ChallengeNameType |
Instances
newRespondToAuthChallenge Source #
Arguments
| :: Text | |
| -> ChallengeNameType | |
| -> RespondToAuthChallenge |
Create a value of RespondToAuthChallenge with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:RespondToAuthChallenge', respondToAuthChallenge_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the RespondToAuthChallenge API action, Amazon
Cognito invokes any functions that are assigned to the following
triggers: post authentication, pre token generation, /define auth
challenge, create auth challenge, and verify auth challenge/. When
Amazon Cognito invokes any of these functions, it passes a JSON payload,
which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your RespondToAuthChallenge request. In
your function code in Lambda, you can process the clientMetadata value
to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:analyticsMetadata:RespondToAuthChallenge', respondToAuthChallenge_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
RespondToAuthChallenge calls.
$sel:challengeResponses:RespondToAuthChallenge', respondToAuthChallenge_challengeResponses - The challenge responses. These are inputs corresponding to the value of
ChallengeName, for example:
SECRET_HASH (if app client is configured with client secret) applies
to all inputs below (including SOFTWARE_TOKEN_MFA).
SMS_MFA:SMS_MFA_CODE,USERNAME.PASSWORD_VERIFIER:PASSWORD_CLAIM_SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK,TIMESTAMP,USERNAME.NEW_PASSWORD_REQUIRED:NEW_PASSWORD, any other required attributes,USERNAME.SOFTWARE_TOKEN_MFA:USERNAMEandSOFTWARE_TOKEN_MFA_CODEare required attributes.DEVICE_SRP_AUTHrequiresUSERNAME,DEVICE_KEY,SRP_A(andSECRET_HASH).DEVICE_PASSWORD_VERIFIERrequires everything thatPASSWORD_VERIFIERrequires plusDEVICE_KEY.MFA_SETUPrequiresUSERNAME, plus you need to use the session value returned byVerifySoftwareTokenin theSessionparameter.
$sel:userContextData:RespondToAuthChallenge', respondToAuthChallenge_userContextData - 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.
$sel:session:RespondToAuthChallenge', respondToAuthChallenge_session - The session which should be passed both ways in challenge-response calls
to the service. If InitiateAuth or RespondToAuthChallenge API call
determines that the caller needs to go through another challenge, they
return a session with other challenge parameters. This session should be
passed as it is to the next RespondToAuthChallenge API call.
$sel:clientId:RespondToAuthChallenge', respondToAuthChallenge_clientId - The app client ID.
$sel:challengeName:RespondToAuthChallenge', respondToAuthChallenge_challengeName - The challenge name. For more information, see
InitiateAuth.
ADMIN_NO_SRP_AUTH is not a valid value.
data RespondToAuthChallengeResponse Source #
The response to respond to the authentication challenge.
See: newRespondToAuthChallengeResponse smart constructor.
Constructors
| RespondToAuthChallengeResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int |
Instances
newRespondToAuthChallengeResponse Source #
Create a value of RespondToAuthChallengeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:challengeName:RespondToAuthChallenge', respondToAuthChallengeResponse_challengeName - The challenge name. For more information, see
InitiateAuth.
$sel:challengeParameters:RespondToAuthChallengeResponse', respondToAuthChallengeResponse_challengeParameters - The challenge parameters. For more information, see
InitiateAuth.
$sel:authenticationResult:RespondToAuthChallengeResponse', respondToAuthChallengeResponse_authenticationResult - The result returned by the server in response to the request to respond
to the authentication challenge.
$sel:session:RespondToAuthChallenge', respondToAuthChallengeResponse_session - The session which should be passed both ways in challenge-response calls
to the service. If the caller needs to go through another challenge,
they return a session with other challenge parameters. This session
should be passed as it is to the next RespondToAuthChallenge API call.
$sel:httpStatus:RespondToAuthChallengeResponse', respondToAuthChallengeResponse_httpStatus - The response's http status code.
CreateUserPool
data CreateUserPool Source #
Represents the request to create a user pool.
See: newCreateUserPool smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> CreateUserPool |
Create a value of CreateUserPool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolTags:CreateUserPool', createUserPool_userPoolTags - The tag keys and values to assign to the user pool. A tag is a label
that you can use to categorize and manage user pools in different ways,
such as by purpose, owner, environment, or other criteria.
$sel:verificationMessageTemplate:CreateUserPool', createUserPool_verificationMessageTemplate - The template for the verification message that the user sees when the
app requests permission to access the user's information.
$sel:emailVerificationMessage:CreateUserPool', createUserPool_emailVerificationMessage - A string representing the email verification message.
EmailVerificationMessage is allowed only if
EmailSendingAccount
is DEVELOPER.
$sel:smsAuthenticationMessage:CreateUserPool', createUserPool_smsAuthenticationMessage - A string representing the SMS authentication message.
$sel:userPoolAddOns:CreateUserPool', createUserPool_userPoolAddOns - Used to enable advanced security risk detection. Set the key
AdvancedSecurityMode to the value "AUDIT".
$sel:emailVerificationSubject:CreateUserPool', createUserPool_emailVerificationSubject - A string representing the email verification subject.
EmailVerificationSubject is allowed only if
EmailSendingAccount
is DEVELOPER.
$sel:usernameAttributes:CreateUserPool', createUserPool_usernameAttributes - Specifies whether email addresses or phone numbers can be specified as
usernames when a user signs up.
$sel:aliasAttributes:CreateUserPool', createUserPool_aliasAttributes - Attributes supported as an alias for this user pool. Possible values:
phone_number, email, or preferred_username.
$sel:schema:CreateUserPool', createUserPool_schema - An array of schema attributes for the new user pool. These attributes
can be standard or custom attributes.
$sel:accountRecoverySetting:CreateUserPool', createUserPool_accountRecoverySetting - Use this setting to define which verified available method a user can
use to recover their password when they call ForgotPassword. It allows
you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password
recovery mechanism if the user also has SMS MFA enabled. In the absence
of this setting, Cognito uses the legacy behavior to determine the
recovery method where SMS is preferred over email.
$sel:emailConfiguration:CreateUserPool', createUserPool_emailConfiguration - The email configuration.
$sel:smsVerificationMessage:CreateUserPool', createUserPool_smsVerificationMessage - A string representing the SMS verification message.
$sel:mfaConfiguration:CreateUserPool', createUserPool_mfaConfiguration - Specifies MFA configuration details.
$sel:lambdaConfig:CreateUserPool', createUserPool_lambdaConfig - The Lambda trigger configuration information for the new user pool.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the CLI, see add-permission .
$sel:smsConfiguration:CreateUserPool', createUserPool_smsConfiguration - The SMS configuration.
$sel:adminCreateUserConfig:CreateUserPool', createUserPool_adminCreateUserConfig - The configuration for AdminCreateUser requests.
$sel:deviceConfiguration:CreateUserPool', createUserPool_deviceConfiguration - The device configuration.
$sel:autoVerifiedAttributes:CreateUserPool', createUserPool_autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email,
phone_number.
$sel:policies:CreateUserPool', createUserPool_policies - The policies associated with the new user pool.
$sel:usernameConfiguration:CreateUserPool', createUserPool_usernameConfiguration - You can choose to set case sensitivity on the username input for the
selected sign-in option. For example, when this is set to False, users
will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information,
see
UsernameConfigurationType.
$sel:poolName:CreateUserPool', createUserPool_poolName - A string used to name the user pool.
data CreateUserPoolResponse Source #
Represents the response from the server for the request to create a user pool.
See: newCreateUserPoolResponse smart constructor.
Constructors
| CreateUserPoolResponse' (Maybe UserPoolType) Int |
Instances
newCreateUserPoolResponse Source #
Create a value of CreateUserPoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPool:CreateUserPoolResponse', createUserPoolResponse_userPool - A container for the user pool details.
$sel:httpStatus:CreateUserPoolResponse', createUserPoolResponse_httpStatus - The response's http status code.
AdminGetDevice
data AdminGetDevice Source #
Represents the request to get the device, as an administrator.
See: newAdminGetDevice smart constructor.
Constructors
| AdminGetDevice' Text Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AdminGetDevice |
Create a value of AdminGetDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceKey:AdminGetDevice', adminGetDevice_deviceKey - The device key.
$sel:userPoolId:AdminGetDevice', adminGetDevice_userPoolId - The user pool ID.
$sel:username:AdminGetDevice', adminGetDevice_username - The user name.
data AdminGetDeviceResponse Source #
Gets the device response, as an administrator.
See: newAdminGetDeviceResponse smart constructor.
Constructors
| AdminGetDeviceResponse' Int DeviceType |
Instances
newAdminGetDeviceResponse Source #
Arguments
| :: Int | |
| -> DeviceType | |
| -> AdminGetDeviceResponse |
Create a value of AdminGetDeviceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminGetDeviceResponse', adminGetDeviceResponse_httpStatus - The response's http status code.
$sel:device:AdminGetDeviceResponse', adminGetDeviceResponse_device - The device.
GetIdentityProviderByIdentifier
data GetIdentityProviderByIdentifier Source #
See: newGetIdentityProviderByIdentifier smart constructor.
Constructors
| GetIdentityProviderByIdentifier' Text Text |
Instances
newGetIdentityProviderByIdentifier Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetIdentityProviderByIdentifier |
Create a value of GetIdentityProviderByIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:GetIdentityProviderByIdentifier', getIdentityProviderByIdentifier_userPoolId - The user pool ID.
$sel:idpIdentifier:GetIdentityProviderByIdentifier', getIdentityProviderByIdentifier_idpIdentifier - The identity provider ID.
data GetIdentityProviderByIdentifierResponse Source #
See: newGetIdentityProviderByIdentifierResponse smart constructor.
Instances
newGetIdentityProviderByIdentifierResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderType |
|
| -> GetIdentityProviderByIdentifierResponse |
Create a value of GetIdentityProviderByIdentifierResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetIdentityProviderByIdentifierResponse', getIdentityProviderByIdentifierResponse_httpStatus - The response's http status code.
$sel:identityProvider:GetIdentityProviderByIdentifierResponse', getIdentityProviderByIdentifierResponse_identityProvider - The identity provider object.
AdminRemoveUserFromGroup
data AdminRemoveUserFromGroup Source #
See: newAdminRemoveUserFromGroup smart constructor.
Constructors
| AdminRemoveUserFromGroup' Text (Sensitive Text) Text |
Instances
newAdminRemoveUserFromGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AdminRemoveUserFromGroup |
Create a value of AdminRemoveUserFromGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminRemoveUserFromGroup', adminRemoveUserFromGroup_userPoolId - The user pool ID for the user pool.
$sel:username:AdminRemoveUserFromGroup', adminRemoveUserFromGroup_username - The username for the user.
$sel:groupName:AdminRemoveUserFromGroup', adminRemoveUserFromGroup_groupName - The group name.
data AdminRemoveUserFromGroupResponse Source #
See: newAdminRemoveUserFromGroupResponse smart constructor.
Constructors
| AdminRemoveUserFromGroupResponse' | |
Instances
newAdminRemoveUserFromGroupResponse :: AdminRemoveUserFromGroupResponse Source #
Create a value of AdminRemoveUserFromGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetRiskConfiguration
data SetRiskConfiguration Source #
See: newSetRiskConfiguration smart constructor.
Constructors
| SetRiskConfiguration' (Maybe RiskExceptionConfigurationType) (Maybe (Sensitive Text)) (Maybe AccountTakeoverRiskConfigurationType) (Maybe CompromisedCredentialsRiskConfigurationType) Text |
Instances
newSetRiskConfiguration Source #
Create a value of SetRiskConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:riskExceptionConfiguration:SetRiskConfiguration', setRiskConfiguration_riskExceptionConfiguration - The configuration to override the risk decision.
$sel:clientId:SetRiskConfiguration', setRiskConfiguration_clientId - The app client ID. If ClientId is null, then the risk configuration is
mapped to userPoolId. When the client ID is null, the same risk
configuration is applied to all the clients in the userPool.
Otherwise, ClientId is mapped to the client. When the client ID is not
null, the user pool configuration is overridden and the risk
configuration for the client is used instead.
$sel:accountTakeoverRiskConfiguration:SetRiskConfiguration', setRiskConfiguration_accountTakeoverRiskConfiguration - The account takeover risk configuration.
$sel:compromisedCredentialsRiskConfiguration:SetRiskConfiguration', setRiskConfiguration_compromisedCredentialsRiskConfiguration - The compromised credentials risk configuration.
$sel:userPoolId:SetRiskConfiguration', setRiskConfiguration_userPoolId - The user pool ID.
data SetRiskConfigurationResponse Source #
See: newSetRiskConfigurationResponse smart constructor.
Constructors
| SetRiskConfigurationResponse' Int RiskConfigurationType |
Instances
newSetRiskConfigurationResponse Source #
Arguments
| :: Int | |
| -> RiskConfigurationType | |
| -> SetRiskConfigurationResponse |
Create a value of SetRiskConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetRiskConfigurationResponse', setRiskConfigurationResponse_httpStatus - The response's http status code.
$sel:riskConfiguration:SetRiskConfigurationResponse', setRiskConfigurationResponse_riskConfiguration - The risk configuration.
ConfirmSignUp
data ConfirmSignUp Source #
Represents the request to confirm registration of a user.
See: newConfirmSignUp smart constructor.
Constructors
| ConfirmSignUp' (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text) Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ConfirmSignUp |
Create a value of ConfirmSignUp with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:ConfirmSignUp', confirmSignUp_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the ConfirmSignUp API action, Amazon Cognito
invokes the function that is assigned to the post confirmation
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your ConfirmSignUp request. In your
function code in Lambda, you can process the clientMetadata value to
enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:forceAliasCreation:ConfirmSignUp', confirmSignUp_forceAliasCreation - Boolean to be specified to force user confirmation irrespective of
existing alias. By default set to False. If this parameter is set to
True and the phone number/email used for sign up confirmation already
exists as an alias with a different user, the API call will migrate the
alias from the previous user to the newly created user being confirmed.
If set to False, the API will throw an AliasExistsException error.
$sel:analyticsMetadata:ConfirmSignUp', confirmSignUp_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmSignUp calls.
$sel:userContextData:ConfirmSignUp', confirmSignUp_userContextData - 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.
$sel:secretHash:ConfirmSignUp', confirmSignUp_secretHash - A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
$sel:clientId:ConfirmSignUp', confirmSignUp_clientId - The ID of the app client associated with the user pool.
$sel:username:ConfirmSignUp', confirmSignUp_username - The user name of the user whose registration you wish to confirm.
$sel:confirmationCode:ConfirmSignUp', confirmSignUp_confirmationCode - The confirmation code sent by a user's request to confirm registration.
data ConfirmSignUpResponse Source #
Represents the response from the server for the registration confirmation.
See: newConfirmSignUpResponse smart constructor.
Constructors
| ConfirmSignUpResponse' Int |
Instances
newConfirmSignUpResponse Source #
Create a value of ConfirmSignUpResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ConfirmSignUpResponse', confirmSignUpResponse_httpStatus - The response's http status code.
ListUserPools (Paginated)
data ListUserPools Source #
Represents the request to list user pools.
See: newListUserPools smart constructor.
Constructors
| ListUserPools' (Maybe Text) Natural |
Instances
Arguments
| :: Natural | |
| -> ListUserPools |
Create a value of ListUserPools with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListUserPools', listUserPools_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListUserPools', listUserPools_maxResults - The maximum number of results you want the request to return when
listing the user pools.
data ListUserPoolsResponse Source #
Represents the response to list user pools.
See: newListUserPoolsResponse smart constructor.
Constructors
| ListUserPoolsResponse' (Maybe [UserPoolDescriptionType]) (Maybe Text) Int |
Instances
newListUserPoolsResponse Source #
Create a value of ListUserPoolsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPools:ListUserPoolsResponse', listUserPoolsResponse_userPools - The user pools from the response to list users.
$sel:nextToken:ListUserPools', listUserPoolsResponse_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:httpStatus:ListUserPoolsResponse', listUserPoolsResponse_httpStatus - The response's http status code.
AdminResetUserPassword
data AdminResetUserPassword Source #
Represents the request to reset a user's password as an administrator.
See: newAdminResetUserPassword smart constructor.
Instances
newAdminResetUserPassword Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminResetUserPassword |
Create a value of AdminResetUserPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminResetUserPassword', adminResetUserPassword_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminResetUserPassword API action, Amazon
Cognito invokes the function that is assigned to the custom message
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your AdminResetUserPassword request. In
your function code in Lambda, you can process the clientMetadata value
to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:userPoolId:AdminResetUserPassword', adminResetUserPassword_userPoolId - The user pool ID for the user pool where you want to reset the user's
password.
$sel:username:AdminResetUserPassword', adminResetUserPassword_username - The user name of the user whose password you wish to reset.
data AdminResetUserPasswordResponse Source #
Represents the response from the server to reset a user password as an administrator.
See: newAdminResetUserPasswordResponse smart constructor.
Constructors
| AdminResetUserPasswordResponse' Int |
Instances
newAdminResetUserPasswordResponse Source #
Create a value of AdminResetUserPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminResetUserPasswordResponse', adminResetUserPasswordResponse_httpStatus - The response's http status code.
UpdateAuthEventFeedback
data UpdateAuthEventFeedback Source #
See: newUpdateAuthEventFeedback smart constructor.
Constructors
| UpdateAuthEventFeedback' Text (Sensitive Text) Text (Sensitive Text) FeedbackValueType |
Instances
newUpdateAuthEventFeedback Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> FeedbackValueType | |
| -> UpdateAuthEventFeedback |
Create a value of UpdateAuthEventFeedback with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:UpdateAuthEventFeedback', updateAuthEventFeedback_userPoolId - The user pool ID.
$sel:username:UpdateAuthEventFeedback', updateAuthEventFeedback_username - The user pool username.
$sel:eventId:UpdateAuthEventFeedback', updateAuthEventFeedback_eventId - The event ID.
$sel:feedbackToken:UpdateAuthEventFeedback', updateAuthEventFeedback_feedbackToken - The feedback token.
$sel:feedbackValue:UpdateAuthEventFeedback', updateAuthEventFeedback_feedbackValue - The authentication event feedback value.
data UpdateAuthEventFeedbackResponse Source #
See: newUpdateAuthEventFeedbackResponse smart constructor.
Constructors
| UpdateAuthEventFeedbackResponse' Int |
Instances
newUpdateAuthEventFeedbackResponse Source #
Create a value of UpdateAuthEventFeedbackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAuthEventFeedbackResponse', updateAuthEventFeedbackResponse_httpStatus - The response's http status code.
CreateUserImportJob
data CreateUserImportJob Source #
Represents the request to create the user import job.
See: newCreateUserImportJob smart constructor.
Constructors
| CreateUserImportJob' Text Text Text |
Instances
newCreateUserImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateUserImportJob |
Create a value of CreateUserImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:CreateUserImportJob', createUserImportJob_jobName - The job name for the user import job.
$sel:userPoolId:CreateUserImportJob', createUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported
into.
$sel:cloudWatchLogsRoleArn:CreateUserImportJob', createUserImportJob_cloudWatchLogsRoleArn - The role ARN for the Amazon CloudWatch Logging role for the user import
job.
data CreateUserImportJobResponse Source #
Represents the response from the server to the request to create the user import job.
See: newCreateUserImportJobResponse smart constructor.
Constructors
| CreateUserImportJobResponse' (Maybe UserImportJobType) Int |
Instances
newCreateUserImportJobResponse Source #
Create a value of CreateUserImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userImportJob:CreateUserImportJobResponse', createUserImportJobResponse_userImportJob - The job object that represents the user import job.
$sel:httpStatus:CreateUserImportJobResponse', createUserImportJobResponse_httpStatus - The response's http status code.
GetUser
Represents the request to get information about the user.
See: newGetUser smart constructor.
Instances
Create a value of GetUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:GetUser', getUser_accessToken - The access token returned by the server response to get information
about the user.
data GetUserResponse Source #
Represents the response from the server from the request to get information about the user.
See: newGetUserResponse smart constructor.
Constructors
| GetUserResponse' (Maybe [Text]) (Maybe [MFAOptionType]) (Maybe Text) Int (Sensitive Text) [AttributeType] |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> GetUserResponse |
Create a value of GetUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userMFASettingList:GetUserResponse', getUserResponse_userMFASettingList - The MFA options that are enabled for the user. The possible values in
this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
$sel:mfaOptions:GetUserResponse', getUserResponse_mfaOptions - This response parameter is no longer supported. It provides
information only about SMS MFA configurations. It doesn't provide
information about TOTP software token MFA configurations. To look up
information about either type of MFA configuration, use
UserMFASettingList instead.
$sel:preferredMfaSetting:GetUserResponse', getUserResponse_preferredMfaSetting - The user's preferred MFA setting.
$sel:httpStatus:GetUserResponse', getUserResponse_httpStatus - The response's http status code.
$sel:username:GetUserResponse', getUserResponse_username - The user name of the user you wish to retrieve from the get user
request.
$sel:userAttributes:GetUserResponse', getUserResponse_userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
GetUICustomization
data GetUICustomization Source #
See: newGetUICustomization smart constructor.
Constructors
| GetUICustomization' (Maybe (Sensitive Text)) Text |
Instances
newGetUICustomization Source #
Arguments
| :: Text | |
| -> GetUICustomization |
Create a value of GetUICustomization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:GetUICustomization', getUICustomization_clientId - The client ID for the client app.
$sel:userPoolId:GetUICustomization', getUICustomization_userPoolId - The user pool ID for the user pool.
data GetUICustomizationResponse Source #
See: newGetUICustomizationResponse smart constructor.
Constructors
| GetUICustomizationResponse' Int UICustomizationType |
Instances
newGetUICustomizationResponse Source #
Arguments
| :: Int | |
| -> UICustomizationType | |
| -> GetUICustomizationResponse |
Create a value of GetUICustomizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetUICustomizationResponse', getUICustomizationResponse_httpStatus - The response's http status code.
$sel:uICustomization:GetUICustomizationResponse', getUICustomizationResponse_uICustomization - The UI customization information.
GetCSVHeader
data GetCSVHeader Source #
Represents the request to get the header information for the .csv file for the user import job.
See: newGetCSVHeader smart constructor.
Constructors
| GetCSVHeader' Text |
Instances
Arguments
| :: Text | |
| -> GetCSVHeader |
Create a value of GetCSVHeader with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:GetCSVHeader', getCSVHeader_userPoolId - The user pool ID for the user pool that the users are to be imported
into.
data GetCSVHeaderResponse Source #
Represents the response from the server to the request to get the header information for the .csv file for the user import job.
See: newGetCSVHeaderResponse smart constructor.
Instances
newGetCSVHeaderResponse Source #
Arguments
| :: Int | |
| -> GetCSVHeaderResponse |
Create a value of GetCSVHeaderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:GetCSVHeader', getCSVHeaderResponse_userPoolId - The user pool ID for the user pool that the users are to be imported
into.
$sel:cSVHeader:GetCSVHeaderResponse', getCSVHeaderResponse_cSVHeader - The header information for the .csv file for the user import job.
$sel:httpStatus:GetCSVHeaderResponse', getCSVHeaderResponse_httpStatus - The response's http status code.
AdminDeleteUser
data AdminDeleteUser Source #
Represents the request to delete a user as an administrator.
See: newAdminDeleteUser smart constructor.
Constructors
| AdminDeleteUser' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AdminDeleteUser |
Create a value of AdminDeleteUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminDeleteUser', adminDeleteUser_userPoolId - The user pool ID for the user pool where you want to delete the user.
$sel:username:AdminDeleteUser', adminDeleteUser_username - The user name of the user you wish to delete.
data AdminDeleteUserResponse Source #
See: newAdminDeleteUserResponse smart constructor.
Constructors
| AdminDeleteUserResponse' | |
Instances
newAdminDeleteUserResponse :: AdminDeleteUserResponse Source #
Create a value of AdminDeleteUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AdminForgetDevice
data AdminForgetDevice Source #
Sends the forgot device request, as an administrator.
See: newAdminForgetDevice smart constructor.
Constructors
| AdminForgetDevice' Text (Sensitive Text) Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AdminForgetDevice |
Create a value of AdminForgetDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminForgetDevice', adminForgetDevice_userPoolId - The user pool ID.
$sel:username:AdminForgetDevice', adminForgetDevice_username - The user name.
$sel:deviceKey:AdminForgetDevice', adminForgetDevice_deviceKey - The device key.
data AdminForgetDeviceResponse Source #
See: newAdminForgetDeviceResponse smart constructor.
Constructors
| AdminForgetDeviceResponse' | |
Instances
newAdminForgetDeviceResponse :: AdminForgetDeviceResponse Source #
Create a value of AdminForgetDeviceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeResourceServer
data DescribeResourceServer Source #
See: newDescribeResourceServer smart constructor.
Constructors
| DescribeResourceServer' Text Text |
Instances
newDescribeResourceServer Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeResourceServer |
Create a value of DescribeResourceServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DescribeResourceServer', describeResourceServer_userPoolId - The user pool ID for the user pool that hosts the resource server.
$sel:identifier:DescribeResourceServer', describeResourceServer_identifier - The identifier for the resource server
data DescribeResourceServerResponse Source #
See: newDescribeResourceServerResponse smart constructor.
Constructors
| DescribeResourceServerResponse' Int ResourceServerType |
Instances
newDescribeResourceServerResponse Source #
Arguments
| :: Int | |
| -> ResourceServerType | |
| -> DescribeResourceServerResponse |
Create a value of DescribeResourceServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeResourceServerResponse', describeResourceServerResponse_httpStatus - The response's http status code.
$sel:resourceServer:DescribeResourceServerResponse', describeResourceServerResponse_resourceServer - The resource server.
SetUserMFAPreference
data SetUserMFAPreference Source #
See: newSetUserMFAPreference smart constructor.
Constructors
| SetUserMFAPreference' (Maybe SMSMfaSettingsType) (Maybe SoftwareTokenMfaSettingsType) (Sensitive Text) |
Instances
newSetUserMFAPreference Source #
Create a value of SetUserMFAPreference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sMSMfaSettings:SetUserMFAPreference', setUserMFAPreference_sMSMfaSettings - The SMS text message multi-factor authentication (MFA) settings.
$sel:softwareTokenMfaSettings:SetUserMFAPreference', setUserMFAPreference_softwareTokenMfaSettings - The time-based one-time password software token MFA settings.
$sel:accessToken:SetUserMFAPreference', setUserMFAPreference_accessToken - The access token for the user.
data SetUserMFAPreferenceResponse Source #
See: newSetUserMFAPreferenceResponse smart constructor.
Constructors
| SetUserMFAPreferenceResponse' Int |
Instances
newSetUserMFAPreferenceResponse Source #
Create a value of SetUserMFAPreferenceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetUserMFAPreferenceResponse', setUserMFAPreferenceResponse_httpStatus - The response's http status code.
AdminUpdateDeviceStatus
data AdminUpdateDeviceStatus Source #
The request to update the device status, as an administrator.
See: newAdminUpdateDeviceStatus smart constructor.
Constructors
| AdminUpdateDeviceStatus' (Maybe DeviceRememberedStatusType) Text (Sensitive Text) Text |
Instances
newAdminUpdateDeviceStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AdminUpdateDeviceStatus |
Create a value of AdminUpdateDeviceStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceRememberedStatus:AdminUpdateDeviceStatus', adminUpdateDeviceStatus_deviceRememberedStatus - The status indicating whether a device has been remembered or not.
$sel:userPoolId:AdminUpdateDeviceStatus', adminUpdateDeviceStatus_userPoolId - The user pool ID.
$sel:username:AdminUpdateDeviceStatus', adminUpdateDeviceStatus_username - The user name.
$sel:deviceKey:AdminUpdateDeviceStatus', adminUpdateDeviceStatus_deviceKey - The device key.
data AdminUpdateDeviceStatusResponse Source #
The status response from the request to update the device, as an administrator.
See: newAdminUpdateDeviceStatusResponse smart constructor.
Constructors
| AdminUpdateDeviceStatusResponse' Int |
Instances
newAdminUpdateDeviceStatusResponse Source #
Create a value of AdminUpdateDeviceStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminUpdateDeviceStatusResponse', adminUpdateDeviceStatusResponse_httpStatus - The response's http status code.
AdminCreateUser
data AdminCreateUser Source #
Represents the request to create a user in the specified user pool.
See: newAdminCreateUser smart constructor.
Constructors
| AdminCreateUser' (Maybe (HashMap Text Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [DeliveryMediumType]) (Maybe MessageActionType) (Maybe [AttributeType]) (Maybe [AttributeType]) Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AdminCreateUser |
Create a value of AdminCreateUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminCreateUser', adminCreateUser_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminCreateUser API action, Amazon Cognito
invokes the function that is assigned to the pre sign-up trigger. When
Amazon Cognito invokes this function, it passes a JSON payload, which
the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the
ClientMetadata parameter in your AdminCreateUser request. In your
function code in Lambda, you can process the clientMetadata value to
enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:temporaryPassword:AdminCreateUser', adminCreateUser_temporaryPassword - The user's temporary password. This password must conform to the
password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account
expiration limit that you specified when you created the user pool. To
reset the account after that time limit, you must call AdminCreateUser
again, specifying "RESEND" for the MessageAction parameter.
$sel:forceAliasCreation:AdminCreateUser', adminCreateUser_forceAliasCreation - This parameter is only used if the phone_number_verified or
email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address
specified in the UserAttributes parameter already exists as an alias
with a different user, the API call will migrate the alias from the
previous user to the newly created user. The previous user will no
longer be able to log in using that alias.
If this parameter is set to False, the API throws an
AliasExistsException error if the alias already exists. The default
value is False.
$sel:desiredDeliveryMediums:AdminCreateUser', adminCreateUser_desiredDeliveryMediums - Specify "EMAIL" if email will be used to send the welcome message.
Specify "SMS" if the phone number will be used. The default value is
"SMS". More than one value can be specified.
$sel:messageAction:AdminCreateUser', adminCreateUser_messageAction - Set to "RESEND" to resend the invitation message to a user that
already exists and reset the expiration limit on the user's account.
Set to "SUPPRESS" to suppress sending the message. Only one value
can be specified.
$sel:userAttributes:AdminCreateUser', adminCreateUser_userAttributes - An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created. You can create a user
without specifying any attributes other than Username. However, any
attributes that you specify as required (when creating a user pool or in
the Attributes tab of the console) must be supplied either by you
(in your call to AdminCreateUser) or by the user (when he or she signs
up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the
attribute name.
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified
attribute to True, and you can set the phone_number_verified
attribute to True. (You can also do this by calling
AdminUpdateUserAttributes.)
- email: The email address of the user to whom the message that
contains the code and username will be sent. Required if the
email_verifiedattribute is set toTrue, or if"EMAIL"is specified in theDesiredDeliveryMediumsparameter. - phone_number: The phone number of the user to whom the message
that contains the code and username will be sent. Required if the
phone_number_verifiedattribute is set toTrue, or if"SMS"is specified in theDesiredDeliveryMediumsparameter.
$sel:validationData:AdminCreateUser', adminCreateUser_validationData - The user's validation data. This is an array of name-value pairs that
contain user attributes and attribute values that you can use for custom
validation, such as restricting the types of user accounts that can be
registered. For example, you might choose to allow or disallow user
sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
$sel:userPoolId:AdminCreateUser', adminCreateUser_userPoolId - The user pool ID for the user pool where the user will be created.
$sel:username:AdminCreateUser', adminCreateUser_username - The username for the user. Must be unique within the user pool. Must be
a UTF-8 string between 1 and 128 characters. After the user is created,
the username cannot be changed.
data AdminCreateUserResponse Source #
Represents the response from the server to the request to create the user.
See: newAdminCreateUserResponse smart constructor.
Constructors
| AdminCreateUserResponse' (Maybe UserType) Int |
Instances
newAdminCreateUserResponse Source #
Create a value of AdminCreateUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:user:AdminCreateUserResponse', adminCreateUserResponse_user - The newly created user.
$sel:httpStatus:AdminCreateUserResponse', adminCreateUserResponse_httpStatus - The response's http status code.
AddCustomAttributes
data AddCustomAttributes Source #
Represents the request to add custom attributes.
See: newAddCustomAttributes smart constructor.
Constructors
| AddCustomAttributes' Text (NonEmpty SchemaAttributeType) |
Instances
newAddCustomAttributes Source #
Arguments
| :: Text | |
| -> NonEmpty SchemaAttributeType | |
| -> AddCustomAttributes |
Create a value of AddCustomAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AddCustomAttributes', addCustomAttributes_userPoolId - The user pool ID for the user pool where you want to add custom
attributes.
$sel:customAttributes:AddCustomAttributes', addCustomAttributes_customAttributes - An array of custom attributes, such as Mutable and Name.
data AddCustomAttributesResponse Source #
Represents the response from the server for the request to add custom attributes.
See: newAddCustomAttributesResponse smart constructor.
Constructors
| AddCustomAttributesResponse' Int |
Instances
newAddCustomAttributesResponse Source #
Create a value of AddCustomAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddCustomAttributesResponse', addCustomAttributesResponse_httpStatus - The response's http status code.
ListUserPoolClients (Paginated)
data ListUserPoolClients Source #
Represents the request to list the user pool clients.
See: newListUserPoolClients smart constructor.
Instances
newListUserPoolClients Source #
Arguments
| :: Text | |
| -> ListUserPoolClients |
Create a value of ListUserPoolClients with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListUserPoolClients', listUserPoolClients_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListUserPoolClients', listUserPoolClients_maxResults - The maximum number of results you want the request to return when
listing the user pool clients.
$sel:userPoolId:ListUserPoolClients', listUserPoolClients_userPoolId - The user pool ID for the user pool where you want to list user pool
clients.
data ListUserPoolClientsResponse Source #
Represents the response from the server that lists user pool clients.
See: newListUserPoolClientsResponse smart constructor.
Constructors
| ListUserPoolClientsResponse' (Maybe Text) (Maybe [UserPoolClientDescription]) Int |
Instances
newListUserPoolClientsResponse Source #
Create a value of ListUserPoolClientsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListUserPoolClients', listUserPoolClientsResponse_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:userPoolClients:ListUserPoolClientsResponse', listUserPoolClientsResponse_userPoolClients - The user pool clients in the response that lists user pool clients.
$sel:httpStatus:ListUserPoolClientsResponse', listUserPoolClientsResponse_httpStatus - The response's http status code.
AdminSetUserMFAPreference
data AdminSetUserMFAPreference Source #
See: newAdminSetUserMFAPreference smart constructor.
Constructors
| AdminSetUserMFAPreference' (Maybe SMSMfaSettingsType) (Maybe SoftwareTokenMfaSettingsType) (Sensitive Text) Text |
Instances
newAdminSetUserMFAPreference Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminSetUserMFAPreference |
Create a value of AdminSetUserMFAPreference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sMSMfaSettings:AdminSetUserMFAPreference', adminSetUserMFAPreference_sMSMfaSettings - The SMS text message MFA settings.
$sel:softwareTokenMfaSettings:AdminSetUserMFAPreference', adminSetUserMFAPreference_softwareTokenMfaSettings - The time-based one-time password software token MFA settings.
$sel:username:AdminSetUserMFAPreference', adminSetUserMFAPreference_username - The user pool username or alias.
$sel:userPoolId:AdminSetUserMFAPreference', adminSetUserMFAPreference_userPoolId - The user pool ID.
data AdminSetUserMFAPreferenceResponse Source #
See: newAdminSetUserMFAPreferenceResponse smart constructor.
Constructors
| AdminSetUserMFAPreferenceResponse' Int |
Instances
newAdminSetUserMFAPreferenceResponse Source #
Arguments
| :: Int | |
| -> AdminSetUserMFAPreferenceResponse |
Create a value of AdminSetUserMFAPreferenceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminSetUserMFAPreferenceResponse', adminSetUserMFAPreferenceResponse_httpStatus - The response's http status code.
UpdateUserPoolClient
data UpdateUserPoolClient Source #
Represents the request to update the user pool client.
See: newUpdateUserPoolClient smart constructor.
Constructors
| UpdateUserPoolClient' (Maybe Natural) (Maybe [ExplicitAuthFlowsType]) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Natural) (Maybe TokenValidityUnitsType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe PreventUserExistenceErrorTypes) (Maybe Natural) (Maybe [Text]) (Maybe [Text]) (Maybe [OAuthFlowType]) (Maybe AnalyticsConfigurationType) (Maybe Text) (Maybe [Text]) Text (Sensitive Text) |
Instances
newUpdateUserPoolClient Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateUserPoolClient |
Create a value of UpdateUserPoolClient with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:refreshTokenValidity:UpdateUserPoolClient', updateUserPoolClient_refreshTokenValidity - The time limit, in days, after which the refresh token is no longer
valid and cannot be used.
$sel:explicitAuthFlows:UpdateUserPoolClient', updateUserPoolClient_explicitAuthFlows - The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor of new
names with the ALLOW_ prefix. Note that values with ALLOW_ prefix
cannot be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH. This setting replaces theADMIN_NO_SRP_AUTHsetting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH: Enable SRP based authentication.ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
$sel:supportedIdentityProviders:UpdateUserPoolClient', updateUserPoolClient_supportedIdentityProviders - A list of provider names for the identity providers that are supported
on this client.
$sel:logoutURLs:UpdateUserPoolClient', updateUserPoolClient_logoutURLs - A list of allowed logout URLs for the identity providers.
$sel:allowedOAuthFlowsUserPoolClient:UpdateUserPoolClient', updateUserPoolClient_allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
$sel:idTokenValidity:UpdateUserPoolClient', updateUserPoolClient_idTokenValidity - The time limit, after which the ID token is no longer valid and cannot
be used.
$sel:tokenValidityUnits:UpdateUserPoolClient', updateUserPoolClient_tokenValidityUnits - The units in which the validity times are represented in. Default for
RefreshToken is days, and default for ID and access tokens are hours.
$sel:defaultRedirectURI:UpdateUserPoolClient', updateUserPoolClient_defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
$sel:enableTokenRevocation:UpdateUserPoolClient', updateUserPoolClient_enableTokenRevocation - Enables or disables token revocation. For more information about
revoking tokens, see
RevokeToken.
$sel:writeAttributes:UpdateUserPoolClient', updateUserPoolClient_writeAttributes - The writeable attributes of the user pool.
$sel:preventUserExistenceErrors:UpdateUserPoolClient', updateUserPoolClient_preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and account
confirmation and password recovery return a response indicating a code
was sent to a simulated destination. When set to LEGACY, those APIs
will return a UserNotFoundException exception if the user does not
exist in the user pool.
Valid values include:
ENABLED- This prevents user existence-related errors.LEGACY- This represents the old behavior of Cognito where user existence related errors are not prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will
default to ENABLED for newly created user pool clients if no value is
provided.
$sel:accessTokenValidity:UpdateUserPoolClient', updateUserPoolClient_accessTokenValidity - The time limit, after which the access token is no longer valid and
cannot be used.
$sel:readAttributes:UpdateUserPoolClient', updateUserPoolClient_readAttributes - The read-only attributes of the user pool.
$sel:allowedOAuthScopes:UpdateUserPoolClient', updateUserPoolClient_allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and profile. Possible values provided by
Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
$sel:allowedOAuthFlows:UpdateUserPoolClient', updateUserPoolClient_allowedOAuthFlows - The allowed OAuth flows.
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 implicit to specify that the client should get the access token
(and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should get the
access token (and, optionally, ID token, based on scopes) from the token
endpoint using a combination of client and client_secret.
$sel:analyticsConfiguration:UpdateUserPoolClient', updateUserPoolClient_analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for
this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
$sel:clientName:UpdateUserPoolClient', updateUserPoolClient_clientName - The client name from the update user pool client request.
$sel:callbackURLs:UpdateUserPoolClient', updateUserPoolClient_callbackURLs - A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
$sel:userPoolId:UpdateUserPoolClient', updateUserPoolClient_userPoolId - The user pool ID for the user pool where you want to update the user
pool client.
$sel:clientId:UpdateUserPoolClient', updateUserPoolClient_clientId - The ID of the client associated with the user pool.
data UpdateUserPoolClientResponse Source #
Represents the response from the server to the request to update the user pool client.
See: newUpdateUserPoolClientResponse smart constructor.
Constructors
| UpdateUserPoolClientResponse' (Maybe UserPoolClientType) Int |
Instances
newUpdateUserPoolClientResponse Source #
Create a value of UpdateUserPoolClientResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolClient:UpdateUserPoolClientResponse', updateUserPoolClientResponse_userPoolClient - The user pool client value from the response from the server when an
update user pool client request is made.
$sel:httpStatus:UpdateUserPoolClientResponse', updateUserPoolClientResponse_httpStatus - The response's http status code.
DeleteUserPoolClient
data DeleteUserPoolClient Source #
Represents the request to delete a user pool client.
See: newDeleteUserPoolClient smart constructor.
Constructors
| DeleteUserPoolClient' Text (Sensitive Text) |
Instances
newDeleteUserPoolClient Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteUserPoolClient |
Create a value of DeleteUserPoolClient with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DeleteUserPoolClient', deleteUserPoolClient_userPoolId - The user pool ID for the user pool where you want to delete the client.
$sel:clientId:DeleteUserPoolClient', deleteUserPoolClient_clientId - The app client ID of the app associated with the user pool.
data DeleteUserPoolClientResponse Source #
See: newDeleteUserPoolClientResponse smart constructor.
Constructors
| DeleteUserPoolClientResponse' | |
Instances
| Eq DeleteUserPoolClientResponse Source # | |
| Read DeleteUserPoolClientResponse Source # | |
| Show DeleteUserPoolClientResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPoolClient Methods showsPrec :: Int -> DeleteUserPoolClientResponse -> ShowS # show :: DeleteUserPoolClientResponse -> String # showList :: [DeleteUserPoolClientResponse] -> ShowS # | |
| Generic DeleteUserPoolClientResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPoolClient Associated Types type Rep DeleteUserPoolClientResponse :: Type -> Type # | |
| NFData DeleteUserPoolClientResponse Source # | |
Defined in Amazonka.CognitoIdentityProvider.DeleteUserPoolClient Methods rnf :: DeleteUserPoolClientResponse -> () # | |
| type Rep DeleteUserPoolClientResponse Source # | |
newDeleteUserPoolClientResponse :: DeleteUserPoolClientResponse Source #
Create a value of DeleteUserPoolClientResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDeviceStatus
data UpdateDeviceStatus Source #
Represents the request to update the device status.
See: newUpdateDeviceStatus smart constructor.
Constructors
| UpdateDeviceStatus' (Maybe DeviceRememberedStatusType) (Sensitive Text) Text |
Instances
newUpdateDeviceStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateDeviceStatus |
Create a value of UpdateDeviceStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceRememberedStatus:UpdateDeviceStatus', updateDeviceStatus_deviceRememberedStatus - The status of whether a device is remembered.
$sel:accessToken:UpdateDeviceStatus', updateDeviceStatus_accessToken - The access token.
$sel:deviceKey:UpdateDeviceStatus', updateDeviceStatus_deviceKey - The device key.
data UpdateDeviceStatusResponse Source #
The response to the request to update the device status.
See: newUpdateDeviceStatusResponse smart constructor.
Constructors
| UpdateDeviceStatusResponse' Int |
Instances
newUpdateDeviceStatusResponse Source #
Create a value of UpdateDeviceStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDeviceStatusResponse', updateDeviceStatusResponse_httpStatus - The response's http status code.
ForgetDevice
data ForgetDevice Source #
Represents the request to forget the device.
See: newForgetDevice smart constructor.
Constructors
| ForgetDevice' (Maybe (Sensitive Text)) Text |
Instances
Arguments
| :: Text | |
| -> ForgetDevice |
Create a value of ForgetDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:ForgetDevice', forgetDevice_accessToken - The access token for the forgotten device request.
$sel:deviceKey:ForgetDevice', forgetDevice_deviceKey - The device key.
data ForgetDeviceResponse Source #
See: newForgetDeviceResponse smart constructor.
Constructors
| ForgetDeviceResponse' | |
Instances
newForgetDeviceResponse :: ForgetDeviceResponse Source #
Create a value of ForgetDeviceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetSigningCertificate
data GetSigningCertificate Source #
Request to get a signing certificate from Cognito.
See: newGetSigningCertificate smart constructor.
Constructors
| GetSigningCertificate' Text |
Instances
newGetSigningCertificate Source #
Create a value of GetSigningCertificate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:GetSigningCertificate', getSigningCertificate_userPoolId - The user pool ID.
data GetSigningCertificateResponse Source #
Response from Cognito for a signing certificate request.
See: newGetSigningCertificateResponse smart constructor.
Constructors
| GetSigningCertificateResponse' (Maybe Text) Int |
Instances
newGetSigningCertificateResponse Source #
Create a value of GetSigningCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificate:GetSigningCertificateResponse', getSigningCertificateResponse_certificate - The signing certificate.
$sel:httpStatus:GetSigningCertificateResponse', getSigningCertificateResponse_httpStatus - The response's http status code.
DeleteUser
data DeleteUser Source #
Represents the request to delete a user.
See: newDeleteUser smart constructor.
Constructors
| DeleteUser' (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> DeleteUser |
Create a value of DeleteUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:DeleteUser', deleteUser_accessToken - The access token from a request to delete a user.
data DeleteUserResponse Source #
See: newDeleteUserResponse smart constructor.
Constructors
| DeleteUserResponse' | |
Instances
newDeleteUserResponse :: DeleteUserResponse Source #
Create a value of DeleteUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the user pool to assign the tags to.
$sel:tags:TagResource', tagResource_tags - The tags to assign to the user pool.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
CreateUserPoolClient
data CreateUserPoolClient Source #
Represents the request to create a user pool client.
See: newCreateUserPoolClient smart constructor.
Constructors
| CreateUserPoolClient' (Maybe Natural) (Maybe [ExplicitAuthFlowsType]) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe TokenValidityUnitsType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe PreventUserExistenceErrorTypes) (Maybe Natural) (Maybe [Text]) (Maybe [Text]) (Maybe [OAuthFlowType]) (Maybe AnalyticsConfigurationType) (Maybe [Text]) Text Text |
Instances
newCreateUserPoolClient Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateUserPoolClient |
Create a value of CreateUserPoolClient with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:refreshTokenValidity:CreateUserPoolClient', createUserPoolClient_refreshTokenValidity - The time limit, in days, after which the refresh token is no longer
valid and cannot be used.
$sel:explicitAuthFlows:CreateUserPoolClient', createUserPoolClient_explicitAuthFlows - The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor of new
names with the ALLOW_ prefix. Note that values with ALLOW_ prefix
cannot be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH. This setting replaces theADMIN_NO_SRP_AUTHsetting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH: Enable SRP based authentication.ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
$sel:supportedIdentityProviders:CreateUserPoolClient', createUserPoolClient_supportedIdentityProviders - A list of provider names for the identity providers that are supported
on this client. The following are supported: COGNITO, Facebook,
Google and LoginWithAmazon.
$sel:logoutURLs:CreateUserPoolClient', createUserPoolClient_logoutURLs - A list of allowed logout URLs for the identity providers.
$sel:allowedOAuthFlowsUserPoolClient:CreateUserPoolClient', createUserPoolClient_allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
$sel:generateSecret:CreateUserPoolClient', createUserPoolClient_generateSecret - Boolean to specify whether you want to generate a secret for the user
pool client being created.
$sel:idTokenValidity:CreateUserPoolClient', createUserPoolClient_idTokenValidity - The time limit, between 5 minutes and 1 day, after which the ID token is
no longer valid and cannot be used. This value will be overridden if you
have entered a value in TokenValidityUnits.
$sel:tokenValidityUnits:CreateUserPoolClient', createUserPoolClient_tokenValidityUnits - The units in which the validity times are represented in. Default for
RefreshToken is days, and default for ID and access tokens are hours.
$sel:defaultRedirectURI:CreateUserPoolClient', createUserPoolClient_defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
$sel:enableTokenRevocation:CreateUserPoolClient', createUserPoolClient_enableTokenRevocation - Enables or disables token revocation. For more information about
revoking tokens, see
RevokeToken.
If you don't include this parameter, token revocation is automatically enabled for the new user pool client.
$sel:writeAttributes:CreateUserPoolClient', createUserPoolClient_writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
$sel:preventUserExistenceErrors:CreateUserPoolClient', createUserPoolClient_preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and account
confirmation and password recovery return a response indicating a code
was sent to a simulated destination. When set to LEGACY, those APIs
will return a UserNotFoundException exception if the user does not
exist in the user pool.
Valid values include:
ENABLED- This prevents user existence-related errors.LEGACY- This represents the old behavior of Cognito where user existence related errors are not prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will
default to ENABLED for newly created user pool clients if no value is
provided.
$sel:accessTokenValidity:CreateUserPoolClient', createUserPoolClient_accessTokenValidity - The time limit, between 5 minutes and 1 day, after which the access
token is no longer valid and cannot be used. This value will be
overridden if you have entered a value in TokenValidityUnits.
$sel:readAttributes:CreateUserPoolClient', createUserPoolClient_readAttributes - The read attributes.
$sel:allowedOAuthScopes:CreateUserPoolClient', createUserPoolClient_allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and profile. Possible values provided by
Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
$sel:allowedOAuthFlows:CreateUserPoolClient', createUserPoolClient_allowedOAuthFlows - The allowed OAuth flows.
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 implicit to specify that the client should get the access token
(and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should get the
access token (and, optionally, ID token, based on scopes) from the token
endpoint using a combination of client and client_secret.
$sel:analyticsConfiguration:CreateUserPoolClient', createUserPoolClient_analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for
this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
$sel:callbackURLs:CreateUserPoolClient', createUserPoolClient_callbackURLs - A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
$sel:userPoolId:CreateUserPoolClient', createUserPoolClient_userPoolId - The user pool ID for the user pool where you want to create a user pool
client.
$sel:clientName:CreateUserPoolClient', createUserPoolClient_clientName - The client name for the user pool client you would like to create.
data CreateUserPoolClientResponse Source #
Represents the response from the server to create a user pool client.
See: newCreateUserPoolClientResponse smart constructor.
Constructors
| CreateUserPoolClientResponse' (Maybe UserPoolClientType) Int |
Instances
newCreateUserPoolClientResponse Source #
Create a value of CreateUserPoolClientResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolClient:CreateUserPoolClientResponse', createUserPoolClientResponse_userPoolClient - The user pool client that was just created.
$sel:httpStatus:CreateUserPoolClientResponse', createUserPoolClientResponse_httpStatus - The response's http status code.
GetUserPoolMfaConfig
data GetUserPoolMfaConfig Source #
See: newGetUserPoolMfaConfig smart constructor.
Constructors
| GetUserPoolMfaConfig' Text |
Instances
newGetUserPoolMfaConfig Source #
Create a value of GetUserPoolMfaConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:GetUserPoolMfaConfig', getUserPoolMfaConfig_userPoolId - The user pool ID.
data GetUserPoolMfaConfigResponse Source #
See: newGetUserPoolMfaConfigResponse smart constructor.
Constructors
| GetUserPoolMfaConfigResponse' (Maybe SmsMfaConfigType) (Maybe SoftwareTokenMfaConfigType) (Maybe UserPoolMfaType) Int |
Instances
newGetUserPoolMfaConfigResponse Source #
Create a value of GetUserPoolMfaConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:smsMfaConfiguration:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_smsMfaConfiguration - The SMS text message multi-factor (MFA) configuration.
$sel:softwareTokenMfaConfiguration:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_softwareTokenMfaConfiguration - The software token multi-factor (MFA) configuration.
$sel:mfaConfiguration:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_mfaConfiguration - The multi-factor (MFA) configuration. Valid values include:
OFFMFA will not be used for any users.ONMFA is required for all users to sign in.OPTIONALMFA will be required only for individual users who have an MFA factor enabled.
$sel:httpStatus:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_httpStatus - The response's http status code.
CreateResourceServer
data CreateResourceServer Source #
See: newCreateResourceServer smart constructor.
Constructors
| CreateResourceServer' (Maybe [ResourceServerScopeType]) Text Text Text |
Instances
newCreateResourceServer Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateResourceServer |
Create a value of CreateResourceServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scopes:CreateResourceServer', createResourceServer_scopes - A list of scopes. Each scope is map, where the keys are name and
description.
$sel:userPoolId:CreateResourceServer', createResourceServer_userPoolId - The user pool ID for the user pool.
$sel:identifier:CreateResourceServer', createResourceServer_identifier - A unique resource server identifier for the resource server. This could
be an HTTPS endpoint where the resource server is located. For example,
https://my-weather-api.example.com.
$sel:name:CreateResourceServer', createResourceServer_name - A friendly name for the resource server.
data CreateResourceServerResponse Source #
See: newCreateResourceServerResponse smart constructor.
Constructors
| CreateResourceServerResponse' Int ResourceServerType |
Instances
newCreateResourceServerResponse Source #
Arguments
| :: Int | |
| -> ResourceServerType | |
| -> CreateResourceServerResponse |
Create a value of CreateResourceServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateResourceServerResponse', createResourceServerResponse_httpStatus - The response's http status code.
$sel:resourceServer:CreateResourceServerResponse', createResourceServerResponse_resourceServer - The newly created resource server.
AdminListUserAuthEvents (Paginated)
data AdminListUserAuthEvents Source #
See: newAdminListUserAuthEvents smart constructor.
Instances
newAdminListUserAuthEvents Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminListUserAuthEvents |
Create a value of AdminListUserAuthEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:AdminListUserAuthEvents', adminListUserAuthEvents_nextToken - A pagination token.
$sel:maxResults:AdminListUserAuthEvents', adminListUserAuthEvents_maxResults - The maximum number of authentication events to return.
$sel:userPoolId:AdminListUserAuthEvents', adminListUserAuthEvents_userPoolId - The user pool ID.
$sel:username:AdminListUserAuthEvents', adminListUserAuthEvents_username - The user pool username or an alias.
data AdminListUserAuthEventsResponse Source #
See: newAdminListUserAuthEventsResponse smart constructor.
Constructors
| AdminListUserAuthEventsResponse' (Maybe Text) (Maybe [AuthEventType]) Int |
Instances
newAdminListUserAuthEventsResponse Source #
Create a value of AdminListUserAuthEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:AdminListUserAuthEvents', adminListUserAuthEventsResponse_nextToken - A pagination token.
$sel:authEvents:AdminListUserAuthEventsResponse', adminListUserAuthEventsResponse_authEvents - The response object. It includes the EventID, EventType,
CreationDate, EventRisk, and EventResponse.
$sel:httpStatus:AdminListUserAuthEventsResponse', adminListUserAuthEventsResponse_httpStatus - The response's http status code.
CreateGroup
data CreateGroup Source #
See: newCreateGroup smart constructor.
Instances
Create a value of CreateGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:precedence:CreateGroup', createGroup_precedence - 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.
Zero is the highest precedence value. Groups with lower Precedence
values take precedence over groups with higher or null Precedence
values. If a user belongs to two or more groups, it is the group with
the lowest precedence value whose role ARN will be used in the
cognito:roles and cognito:preferred_role claims in the user's
tokens.
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.
$sel:description:CreateGroup', createGroup_description - A string containing the description of the group.
$sel:roleArn:CreateGroup', createGroup_roleArn - The role ARN for the group.
$sel:groupName:CreateGroup', createGroup_groupName - The name of the group. Must be unique.
$sel:userPoolId:CreateGroup', createGroup_userPoolId - The user pool ID for the user pool.
data CreateGroupResponse Source #
See: newCreateGroupResponse smart constructor.
Constructors
| CreateGroupResponse' (Maybe GroupType) Int |
Instances
newCreateGroupResponse Source #
Arguments
| :: Int | |
| -> CreateGroupResponse |
Create a value of CreateGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':CreateGroupResponse', createGroupResponse_group - The group object for the group.
$sel:httpStatus:CreateGroupResponse', createGroupResponse_httpStatus - The response's http status code.
AdminAddUserToGroup
data AdminAddUserToGroup Source #
See: newAdminAddUserToGroup smart constructor.
Constructors
| AdminAddUserToGroup' Text (Sensitive Text) Text |
Instances
newAdminAddUserToGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AdminAddUserToGroup |
Create a value of AdminAddUserToGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminAddUserToGroup', adminAddUserToGroup_userPoolId - The user pool ID for the user pool.
$sel:username:AdminAddUserToGroup', adminAddUserToGroup_username - The username for the user.
$sel:groupName:AdminAddUserToGroup', adminAddUserToGroup_groupName - The group name.
data AdminAddUserToGroupResponse Source #
See: newAdminAddUserToGroupResponse smart constructor.
Constructors
| AdminAddUserToGroupResponse' | |
Instances
newAdminAddUserToGroupResponse :: AdminAddUserToGroupResponse Source #
Create a value of AdminAddUserToGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
VerifySoftwareToken
data VerifySoftwareToken Source #
See: newVerifySoftwareToken smart constructor.
Instances
newVerifySoftwareToken Source #
Arguments
| :: Text | |
| -> VerifySoftwareToken |
Create a value of VerifySoftwareToken with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:VerifySoftwareToken', verifySoftwareToken_accessToken - The access token.
$sel:friendlyDeviceName:VerifySoftwareToken', verifySoftwareToken_friendlyDeviceName - The friendly device name.
$sel:session:VerifySoftwareToken', verifySoftwareToken_session - The session which should be passed both ways in challenge-response calls
to the service.
$sel:userCode:VerifySoftwareToken', verifySoftwareToken_userCode - The one time password computed using the secret code returned by
AssociateSoftwareToken".
data VerifySoftwareTokenResponse Source #
See: newVerifySoftwareTokenResponse smart constructor.
Constructors
| VerifySoftwareTokenResponse' (Maybe VerifySoftwareTokenResponseType) (Maybe Text) Int |
Instances
newVerifySoftwareTokenResponse Source #
Create a value of VerifySoftwareTokenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:VerifySoftwareTokenResponse', verifySoftwareTokenResponse_status - The status of the verify software token.
$sel:session:VerifySoftwareToken', verifySoftwareTokenResponse_session - The session which should be passed both ways in challenge-response calls
to the service.
$sel:httpStatus:VerifySoftwareTokenResponse', verifySoftwareTokenResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the user pool that the tags are
assigned to.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The keys of the tags to remove from the user pool.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
RevokeToken
data RevokeToken Source #
See: newRevokeToken smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RevokeToken |
Create a value of RevokeToken with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientSecret:RevokeToken', revokeToken_clientSecret - The secret for the client ID. This is required only if the client ID has
a secret.
$sel:token:RevokeToken', revokeToken_token - The token that you want to revoke.
$sel:clientId:RevokeToken', revokeToken_clientId - The client ID for the token that you want to revoke.
data RevokeTokenResponse Source #
See: newRevokeTokenResponse smart constructor.
Constructors
| RevokeTokenResponse' Int |
Instances
newRevokeTokenResponse Source #
Arguments
| :: Int | |
| -> RevokeTokenResponse |
Create a value of RevokeTokenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RevokeTokenResponse', revokeTokenResponse_httpStatus - The response's http status code.
StopUserImportJob
data StopUserImportJob Source #
Represents the request to stop the user import job.
See: newStopUserImportJob smart constructor.
Constructors
| StopUserImportJob' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> StopUserImportJob |
Create a value of StopUserImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:StopUserImportJob', stopUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported
into.
$sel:jobId:StopUserImportJob', stopUserImportJob_jobId - The job ID for the user import job.
data StopUserImportJobResponse Source #
Represents the response from the server to the request to stop the user import job.
See: newStopUserImportJobResponse smart constructor.
Constructors
| StopUserImportJobResponse' (Maybe UserImportJobType) Int |
Instances
newStopUserImportJobResponse Source #
Create a value of StopUserImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userImportJob:StopUserImportJobResponse', stopUserImportJobResponse_userImportJob - The job object that represents the user import job.
$sel:httpStatus:StopUserImportJobResponse', stopUserImportJobResponse_httpStatus - The response's http status code.
DescribeUserImportJob
data DescribeUserImportJob Source #
Represents the request to describe the user import job.
See: newDescribeUserImportJob smart constructor.
Constructors
| DescribeUserImportJob' Text Text |
Instances
newDescribeUserImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeUserImportJob |
Create a value of DescribeUserImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DescribeUserImportJob', describeUserImportJob_userPoolId - The user pool ID for the user pool that the users are being imported
into.
$sel:jobId:DescribeUserImportJob', describeUserImportJob_jobId - The job ID for the user import job.
data DescribeUserImportJobResponse Source #
Represents the response from the server to the request to describe the user import job.
See: newDescribeUserImportJobResponse smart constructor.
Constructors
| DescribeUserImportJobResponse' (Maybe UserImportJobType) Int |
Instances
newDescribeUserImportJobResponse Source #
Create a value of DescribeUserImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userImportJob:DescribeUserImportJobResponse', describeUserImportJobResponse_userImportJob - The job object that represents the user import job.
$sel:httpStatus:DescribeUserImportJobResponse', describeUserImportJobResponse_httpStatus - The response's http status code.
DescribeRiskConfiguration
data DescribeRiskConfiguration Source #
See: newDescribeRiskConfiguration smart constructor.
Constructors
| DescribeRiskConfiguration' (Maybe (Sensitive Text)) Text |
Instances
newDescribeRiskConfiguration Source #
Create a value of DescribeRiskConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:DescribeRiskConfiguration', describeRiskConfiguration_clientId - The app client ID.
$sel:userPoolId:DescribeRiskConfiguration', describeRiskConfiguration_userPoolId - The user pool ID.
data DescribeRiskConfigurationResponse Source #
See: newDescribeRiskConfigurationResponse smart constructor.
Instances
newDescribeRiskConfigurationResponse Source #
Arguments
| :: Int | |
| -> RiskConfigurationType | |
| -> DescribeRiskConfigurationResponse |
Create a value of DescribeRiskConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeRiskConfigurationResponse', describeRiskConfigurationResponse_httpStatus - The response's http status code.
$sel:riskConfiguration:DescribeRiskConfigurationResponse', describeRiskConfigurationResponse_riskConfiguration - The risk configuration.
DeleteGroup
data DeleteGroup Source #
See: newDeleteGroup smart constructor.
Constructors
| DeleteGroup' Text Text |
Instances
Create a value of DeleteGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupName:DeleteGroup', deleteGroup_groupName - The name of the group.
$sel:userPoolId:DeleteGroup', deleteGroup_userPoolId - The user pool ID for the user pool.
data DeleteGroupResponse Source #
See: newDeleteGroupResponse smart constructor.
Constructors
| DeleteGroupResponse' | |
Instances
newDeleteGroupResponse :: DeleteGroupResponse Source #
Create a value of DeleteGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateGroup
data UpdateGroup Source #
See: newUpdateGroup smart constructor.
Instances
Create a value of UpdateGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:precedence:UpdateGroup', updateGroup_precedence - The new precedence value for the group. For more information about this
parameter, see
CreateGroup.
$sel:description:UpdateGroup', updateGroup_description - A string containing the new description of the group.
$sel:roleArn:UpdateGroup', updateGroup_roleArn - The new role ARN for the group. This is used for setting the
cognito:roles and cognito:preferred_role claims in the token.
$sel:groupName:UpdateGroup', updateGroup_groupName - The name of the group.
$sel:userPoolId:UpdateGroup', updateGroup_userPoolId - The user pool ID for the user pool.
data UpdateGroupResponse Source #
See: newUpdateGroupResponse smart constructor.
Constructors
| UpdateGroupResponse' (Maybe GroupType) Int |
Instances
newUpdateGroupResponse Source #
Arguments
| :: Int | |
| -> UpdateGroupResponse |
Create a value of UpdateGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':UpdateGroupResponse', updateGroupResponse_group - The group object for the group.
$sel:httpStatus:UpdateGroupResponse', updateGroupResponse_httpStatus - The response's http status code.
GlobalSignOut
data GlobalSignOut Source #
Represents the request to sign out all devices.
See: newGlobalSignOut smart constructor.
Constructors
| GlobalSignOut' (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> GlobalSignOut |
Create a value of GlobalSignOut with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:GlobalSignOut', globalSignOut_accessToken - The access token.
data GlobalSignOutResponse Source #
The response to the request to sign out all devices.
See: newGlobalSignOutResponse smart constructor.
Constructors
| GlobalSignOutResponse' Int |
Instances
newGlobalSignOutResponse Source #
Create a value of GlobalSignOutResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GlobalSignOutResponse', globalSignOutResponse_httpStatus - The response's http status code.
ListGroups (Paginated)
data ListGroups Source #
See: newListGroups smart constructor.
Instances
Arguments
| :: Text | |
| -> ListGroups |
Create a value of ListGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListGroups', listGroups_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:limit:ListGroups', listGroups_limit - The limit of the request to list groups.
$sel:userPoolId:ListGroups', listGroups_userPoolId - The user pool ID for the user pool.
data ListGroupsResponse Source #
See: newListGroupsResponse smart constructor.
Instances
newListGroupsResponse Source #
Arguments
| :: Int | |
| -> ListGroupsResponse |
Create a value of ListGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:ListGroupsResponse', listGroupsResponse_groups - The group objects for the groups.
$sel:nextToken:ListGroups', listGroupsResponse_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.
UpdateIdentityProvider
data UpdateIdentityProvider Source #
See: newUpdateIdentityProvider smart constructor.
Constructors
| UpdateIdentityProvider' (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text Text |
Instances
newUpdateIdentityProvider Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateIdentityProvider |
Create a value of UpdateIdentityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idpIdentifiers:UpdateIdentityProvider', updateIdentityProvider_idpIdentifiers - A list of identity provider identifiers.
$sel:attributeMapping:UpdateIdentityProvider', updateIdentityProvider_attributeMapping - The identity provider attribute mapping to be changed.
$sel:providerDetails:UpdateIdentityProvider', updateIdentityProvider_providerDetails - The identity provider details to be updated, such as MetadataURL and
MetadataFile.
$sel:userPoolId:UpdateIdentityProvider', updateIdentityProvider_userPoolId - The user pool ID.
$sel:providerName:UpdateIdentityProvider', updateIdentityProvider_providerName - The identity provider name.
data UpdateIdentityProviderResponse Source #
See: newUpdateIdentityProviderResponse smart constructor.
Constructors
| UpdateIdentityProviderResponse' Int IdentityProviderType |
Instances
newUpdateIdentityProviderResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderType | |
| -> UpdateIdentityProviderResponse |
Create a value of UpdateIdentityProviderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateIdentityProviderResponse', updateIdentityProviderResponse_httpStatus - The response's http status code.
$sel:identityProvider:UpdateIdentityProviderResponse', updateIdentityProviderResponse_identityProvider - The identity provider object.
DeleteIdentityProvider
data DeleteIdentityProvider Source #
See: newDeleteIdentityProvider smart constructor.
Constructors
| DeleteIdentityProvider' Text Text |
Instances
newDeleteIdentityProvider Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteIdentityProvider |
Create a value of DeleteIdentityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DeleteIdentityProvider', deleteIdentityProvider_userPoolId - The user pool ID.
$sel:providerName:DeleteIdentityProvider', deleteIdentityProvider_providerName - The identity provider name.
data DeleteIdentityProviderResponse Source #
See: newDeleteIdentityProviderResponse smart constructor.
Constructors
| DeleteIdentityProviderResponse' | |
Instances
newDeleteIdentityProviderResponse :: DeleteIdentityProviderResponse Source #
Create a value of DeleteIdentityProviderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListResourceServers (Paginated)
data ListResourceServers Source #
See: newListResourceServers smart constructor.
Instances
newListResourceServers Source #
Arguments
| :: Text | |
| -> ListResourceServers |
Create a value of ListResourceServers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListResourceServers', listResourceServers_nextToken - A pagination token.
$sel:maxResults:ListResourceServers', listResourceServers_maxResults - The maximum number of resource servers to return.
$sel:userPoolId:ListResourceServers', listResourceServers_userPoolId - The user pool ID for the user pool.
data ListResourceServersResponse Source #
See: newListResourceServersResponse smart constructor.
Constructors
| ListResourceServersResponse' (Maybe Text) Int [ResourceServerType] |
Instances
newListResourceServersResponse Source #
Create a value of ListResourceServersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListResourceServers', listResourceServersResponse_nextToken - A pagination token.
$sel:httpStatus:ListResourceServersResponse', listResourceServersResponse_httpStatus - The response's http status code.
$sel:resourceServers:ListResourceServersResponse', listResourceServersResponse_resourceServers - The resource servers.
AdminRespondToAuthChallenge
data AdminRespondToAuthChallenge Source #
The request to respond to the authentication challenge, as an administrator.
See: newAdminRespondToAuthChallenge smart constructor.
Constructors
| AdminRespondToAuthChallenge' (Maybe (HashMap Text Text)) (Maybe ContextDataType) (Maybe AnalyticsMetadataType) (Maybe (HashMap Text Text)) (Maybe Text) Text (Sensitive Text) ChallengeNameType |
Instances
newAdminRespondToAuthChallenge Source #
Arguments
| :: Text | |
| -> Text | |
| -> ChallengeNameType | |
| -> AdminRespondToAuthChallenge |
Create a value of AdminRespondToAuthChallenge with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminRespondToAuthChallenge API action,
Amazon Cognito invokes any functions that are assigned to the following
triggers: pre sign-up, custom message, post authentication, /user
migration, pre token generation, define auth challenge, create
auth challenge, and verify auth challenge response/. When Amazon
Cognito invokes any of these functions, it passes a JSON payload, which
the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the
ClientMetadata parameter in your AdminRespondToAuthChallenge request. In
your function code in Lambda, you can process the clientMetadata value
to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:contextData:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_contextData - 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.
$sel:analyticsMetadata:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_analyticsMetadata - The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge calls.
$sel:challengeResponses:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_challengeResponses - The challenge responses. These are inputs corresponding to the value of
ChallengeName, for example:
SMS_MFA:SMS_MFA_CODE,USERNAME,SECRET_HASH(if app client is configured with client secret).PASSWORD_VERIFIER:PASSWORD_CLAIM_SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK,TIMESTAMP,USERNAME,SECRET_HASH(if app client is configured with client secret).ADMIN_NO_SRP_AUTH:PASSWORD,USERNAME,SECRET_HASH(if app client is configured with client secret).NEW_PASSWORD_REQUIRED:NEW_PASSWORD, any other required attributes,USERNAME,SECRET_HASH(if app client is configured with client secret).MFA_SETUPrequiresUSERNAME, plus you need to use the session value returned byVerifySoftwareTokenin theSessionparameter.
The value of the USERNAME attribute must be the user's actual
username, not an alias (such as email address or phone number). To make
this easier, the AdminInitiateAuth response includes the actual
username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you
specified an alias in your call to AdminInitiateAuth.
$sel:session:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_session - The session which should be passed both ways in challenge-response calls
to the service. If InitiateAuth or RespondToAuthChallenge API call
determines that the caller needs to go through another challenge, they
return a session with other challenge parameters. This session should be
passed as it is to the next RespondToAuthChallenge API call.
$sel:userPoolId:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_userPoolId - The ID of the Amazon Cognito user pool.
$sel:clientId:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_clientId - The app client ID.
$sel:challengeName:AdminRespondToAuthChallenge', adminRespondToAuthChallenge_challengeName - The challenge name. For more information, see
AdminInitiateAuth.
data AdminRespondToAuthChallengeResponse Source #
Responds to the authentication challenge, as an administrator.
See: newAdminRespondToAuthChallengeResponse smart constructor.
Constructors
| AdminRespondToAuthChallengeResponse' (Maybe ChallengeNameType) (Maybe (HashMap Text Text)) (Maybe AuthenticationResultType) (Maybe Text) Int |
Instances
newAdminRespondToAuthChallengeResponse Source #
Arguments
| :: Int | |
| -> AdminRespondToAuthChallengeResponse |
Create a value of AdminRespondToAuthChallengeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:challengeName:AdminRespondToAuthChallenge', adminRespondToAuthChallengeResponse_challengeName - The name of the challenge. For more information, see
AdminInitiateAuth.
$sel:challengeParameters:AdminRespondToAuthChallengeResponse', adminRespondToAuthChallengeResponse_challengeParameters - The challenge parameters. For more information, see
AdminInitiateAuth.
$sel:authenticationResult:AdminRespondToAuthChallengeResponse', adminRespondToAuthChallengeResponse_authenticationResult - The result returned by the server in response to the authentication
request.
$sel:session:AdminRespondToAuthChallenge', adminRespondToAuthChallengeResponse_session - The session which should be passed both ways in challenge-response calls
to the service. If the caller needs to go through another challenge,
they return a session with other challenge parameters. This session
should be passed as it is to the next RespondToAuthChallenge API call.
$sel:httpStatus:AdminRespondToAuthChallengeResponse', adminRespondToAuthChallengeResponse_httpStatus - The response's http status code.
SetUserSettings
data SetUserSettings Source #
Represents the request to set user settings.
See: newSetUserSettings smart constructor.
Constructors
| SetUserSettings' (Sensitive Text) [MFAOptionType] |
Instances
Arguments
| :: Text | |
| -> SetUserSettings |
Create a value of SetUserSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:SetUserSettings', setUserSettings_accessToken - The access token for the set user settings request.
$sel:mfaOptions:SetUserSettings', setUserSettings_mfaOptions - You can use this parameter only to set an SMS configuration that uses
SMS for delivery.
data SetUserSettingsResponse Source #
The response from the server for a set user settings request.
See: newSetUserSettingsResponse smart constructor.
Constructors
| SetUserSettingsResponse' Int |
Instances
newSetUserSettingsResponse Source #
Create a value of SetUserSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetUserSettingsResponse', setUserSettingsResponse_httpStatus - The response's http status code.
AdminListDevices
data AdminListDevices Source #
Represents the request to list devices, as an administrator.
See: newAdminListDevices smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AdminListDevices |
Create a value of AdminListDevices with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:AdminListDevices', adminListDevices_paginationToken - The pagination token.
$sel:limit:AdminListDevices', adminListDevices_limit - The limit of the devices request.
$sel:userPoolId:AdminListDevices', adminListDevices_userPoolId - The user pool ID.
$sel:username:AdminListDevices', adminListDevices_username - The user name.
data AdminListDevicesResponse Source #
Lists the device's response, as an administrator.
See: newAdminListDevicesResponse smart constructor.
Constructors
| AdminListDevicesResponse' (Maybe Text) (Maybe [DeviceType]) Int |
Instances
newAdminListDevicesResponse Source #
Create a value of AdminListDevicesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:AdminListDevices', adminListDevicesResponse_paginationToken - The pagination token.
$sel:devices:AdminListDevicesResponse', adminListDevicesResponse_devices - The devices in the list of devices response.
$sel:httpStatus:AdminListDevicesResponse', adminListDevicesResponse_httpStatus - The response's http status code.
DescribeUserPoolClient
data DescribeUserPoolClient Source #
Represents the request to describe a user pool client.
See: newDescribeUserPoolClient smart constructor.
Constructors
| DescribeUserPoolClient' Text (Sensitive Text) |
Instances
newDescribeUserPoolClient Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeUserPoolClient |
Create a value of DescribeUserPoolClient with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:DescribeUserPoolClient', describeUserPoolClient_userPoolId - The user pool ID for the user pool you want to describe.
$sel:clientId:DescribeUserPoolClient', describeUserPoolClient_clientId - The app client ID of the app associated with the user pool.
data DescribeUserPoolClientResponse Source #
Represents the response from the server from a request to describe the user pool client.
See: newDescribeUserPoolClientResponse smart constructor.
Constructors
| DescribeUserPoolClientResponse' (Maybe UserPoolClientType) Int |
Instances
newDescribeUserPoolClientResponse Source #
Create a value of DescribeUserPoolClientResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolClient:DescribeUserPoolClientResponse', describeUserPoolClientResponse_userPoolClient - The user pool client from a server response to describe the user pool
client.
$sel:httpStatus:DescribeUserPoolClientResponse', describeUserPoolClientResponse_httpStatus - The response's http status code.
ResendConfirmationCode
data ResendConfirmationCode Source #
Represents the request to resend the confirmation code.
See: newResendConfirmationCode smart constructor.
Constructors
| ResendConfirmationCode' (Maybe (HashMap Text Text)) (Maybe AnalyticsMetadataType) (Maybe UserContextDataType) (Maybe (Sensitive Text)) (Sensitive Text) (Sensitive Text) |
Instances
newResendConfirmationCode Source #
Arguments
| :: Text | |
| -> Text | |
| -> ResendConfirmationCode |
Create a value of ResendConfirmationCode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:ResendConfirmationCode', resendConfirmationCode_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the ResendConfirmationCode API action, Amazon
Cognito invokes the function that is assigned to the custom message
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your ResendConfirmationCode request. In
your function code in Lambda, you can process the clientMetadata value
to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
- Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
- Amazon Cognito does not validate the ClientMetadata value.
- Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
$sel:analyticsMetadata:ResendConfirmationCode', resendConfirmationCode_analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for
ResendConfirmationCode calls.
$sel:userContextData:ResendConfirmationCode', resendConfirmationCode_userContextData - 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.
$sel:secretHash:ResendConfirmationCode', resendConfirmationCode_secretHash - A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the
message.
$sel:clientId:ResendConfirmationCode', resendConfirmationCode_clientId - The ID of the client associated with the user pool.
$sel:username:ResendConfirmationCode', resendConfirmationCode_username - The user name of the user to whom you wish to resend a confirmation
code.
data ResendConfirmationCodeResponse Source #
The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.
See: newResendConfirmationCodeResponse smart constructor.
Constructors
| ResendConfirmationCodeResponse' (Maybe CodeDeliveryDetailsType) Int |
Instances
newResendConfirmationCodeResponse Source #
Create a value of ResendConfirmationCodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeDeliveryDetails:ResendConfirmationCodeResponse', resendConfirmationCodeResponse_codeDeliveryDetails - The code delivery details returned by the server in response to the
request to resend the confirmation code.
$sel:httpStatus:ResendConfirmationCodeResponse', resendConfirmationCodeResponse_httpStatus - The response's http status code.
GetGroup
See: newGetGroup smart constructor.
Instances
Create a value of GetGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupName:GetGroup', getGroup_groupName - The name of the group.
$sel:userPoolId:GetGroup', getGroup_userPoolId - The user pool ID for the user pool.
data GetGroupResponse Source #
See: newGetGroupResponse smart constructor.
Constructors
| GetGroupResponse' (Maybe GroupType) Int |
Instances
Arguments
| :: Int | |
| -> GetGroupResponse |
Create a value of GetGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:group':GetGroupResponse', getGroupResponse_group - The group object for the group.
$sel:httpStatus:GetGroupResponse', getGroupResponse_httpStatus - The response's http status code.
AdminSetUserSettings
data AdminSetUserSettings Source #
You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
See: newAdminSetUserSettings smart constructor.
Constructors
| AdminSetUserSettings' Text (Sensitive Text) [MFAOptionType] |
Instances
newAdminSetUserSettings Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminSetUserSettings |
Create a value of AdminSetUserSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:AdminSetUserSettings', adminSetUserSettings_userPoolId - The ID of the user pool that contains the user that you are setting
options for.
$sel:username:AdminSetUserSettings', adminSetUserSettings_username - The user name of the user that you are setting options for.
$sel:mfaOptions:AdminSetUserSettings', adminSetUserSettings_mfaOptions - You can use this parameter only to set an SMS configuration that uses
SMS for delivery.
data AdminSetUserSettingsResponse Source #
Represents the response from the server to set user settings as an administrator.
See: newAdminSetUserSettingsResponse smart constructor.
Constructors
| AdminSetUserSettingsResponse' Int |
Instances
newAdminSetUserSettingsResponse Source #
Create a value of AdminSetUserSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminSetUserSettingsResponse', adminSetUserSettingsResponse_httpStatus - The response's http status code.
ListDevices
data ListDevices Source #
Represents the request to list the devices.
See: newListDevices smart constructor.
Instances
Arguments
| :: Text | |
| -> ListDevices |
Create a value of ListDevices with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:ListDevices', listDevices_paginationToken - The pagination token for the list request.
$sel:limit:ListDevices', listDevices_limit - The limit of the device request.
$sel:accessToken:ListDevices', listDevices_accessToken - The access tokens for the request to list devices.
data ListDevicesResponse Source #
Represents the response to list devices.
See: newListDevicesResponse smart constructor.
Constructors
| ListDevicesResponse' (Maybe Text) (Maybe [DeviceType]) Int |
Instances
newListDevicesResponse Source #
Arguments
| :: Int | |
| -> ListDevicesResponse |
Create a value of ListDevicesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:ListDevices', listDevicesResponse_paginationToken - The pagination token for the list device response.
$sel:devices:ListDevicesResponse', listDevicesResponse_devices - The devices returned in the list devices response.
$sel:httpStatus:ListDevicesResponse', listDevicesResponse_httpStatus - The response's http status code.
Types
AccountTakeoverEventActionType
newtype AccountTakeoverEventActionType Source #
Constructors
| AccountTakeoverEventActionType' | |
Fields | |
Bundled Patterns
Instances
AdvancedSecurityModeType
newtype AdvancedSecurityModeType Source #
Constructors
| AdvancedSecurityModeType' | |
Fields | |
Bundled Patterns
Instances
AliasAttributeType
newtype AliasAttributeType Source #
Constructors
| AliasAttributeType' | |
Fields | |
Bundled Patterns
| pattern AliasAttributeType_Email :: AliasAttributeType | |
| pattern AliasAttributeType_Phone_number :: AliasAttributeType | |
| pattern AliasAttributeType_Preferred_username :: AliasAttributeType |
Instances
AttributeDataType
newtype AttributeDataType Source #
Constructors
| AttributeDataType' | |
Fields | |
Bundled Patterns
| pattern AttributeDataType_Boolean :: AttributeDataType | |
| pattern AttributeDataType_DateTime :: AttributeDataType | |
| pattern AttributeDataType_Number :: AttributeDataType | |
| pattern AttributeDataType_String :: AttributeDataType |
Instances
AuthFlowType
newtype AuthFlowType Source #
Constructors
| AuthFlowType' | |
Fields | |
Bundled Patterns
| pattern AuthFlowType_ADMIN_NO_SRP_AUTH :: AuthFlowType | |
| pattern AuthFlowType_ADMIN_USER_PASSWORD_AUTH :: AuthFlowType | |
| pattern AuthFlowType_CUSTOM_AUTH :: AuthFlowType | |
| pattern AuthFlowType_REFRESH_TOKEN :: AuthFlowType | |
| pattern AuthFlowType_REFRESH_TOKEN_AUTH :: AuthFlowType | |
| pattern AuthFlowType_USER_PASSWORD_AUTH :: AuthFlowType | |
| pattern AuthFlowType_USER_SRP_AUTH :: AuthFlowType |
Instances
ChallengeName
newtype ChallengeName Source #
Constructors
| ChallengeName' | |
Fields | |
Bundled Patterns
| pattern ChallengeName_Mfa :: ChallengeName | |
| pattern ChallengeName_Password :: ChallengeName |
Instances
ChallengeNameType
newtype ChallengeNameType Source #
Constructors
| ChallengeNameType' | |
Fields | |
Bundled Patterns
| pattern ChallengeNameType_ADMIN_NO_SRP_AUTH :: ChallengeNameType | |
| pattern ChallengeNameType_CUSTOM_CHALLENGE :: ChallengeNameType | |
| pattern ChallengeNameType_DEVICE_PASSWORD_VERIFIER :: ChallengeNameType | |
| pattern ChallengeNameType_DEVICE_SRP_AUTH :: ChallengeNameType | |
| pattern ChallengeNameType_MFA_SETUP :: ChallengeNameType | |
| pattern ChallengeNameType_NEW_PASSWORD_REQUIRED :: ChallengeNameType | |
| pattern ChallengeNameType_PASSWORD_VERIFIER :: ChallengeNameType | |
| pattern ChallengeNameType_SELECT_MFA_TYPE :: ChallengeNameType | |
| pattern ChallengeNameType_SMS_MFA :: ChallengeNameType | |
| pattern ChallengeNameType_SOFTWARE_TOKEN_MFA :: ChallengeNameType |
Instances
ChallengeResponse
newtype ChallengeResponse Source #
Constructors
| ChallengeResponse' | |
Fields | |
Bundled Patterns
| pattern ChallengeResponse_Failure :: ChallengeResponse | |
| pattern ChallengeResponse_Success :: ChallengeResponse |
Instances
CompromisedCredentialsEventActionType
newtype CompromisedCredentialsEventActionType Source #
Constructors
| CompromisedCredentialsEventActionType' | |
Bundled Patterns
| pattern CompromisedCredentialsEventActionType_BLOCK :: CompromisedCredentialsEventActionType | |
| pattern CompromisedCredentialsEventActionType_NO_ACTION :: CompromisedCredentialsEventActionType |
Instances
CustomEmailSenderLambdaVersionType
newtype CustomEmailSenderLambdaVersionType Source #
Constructors
| CustomEmailSenderLambdaVersionType' | |
Bundled Patterns
| pattern CustomEmailSenderLambdaVersionType_V1_0 :: CustomEmailSenderLambdaVersionType |
Instances
CustomSMSSenderLambdaVersionType
newtype CustomSMSSenderLambdaVersionType Source #
Constructors
| CustomSMSSenderLambdaVersionType' | |
Fields | |
Bundled Patterns
| pattern CustomSMSSenderLambdaVersionType_V1_0 :: CustomSMSSenderLambdaVersionType |
Instances
DefaultEmailOptionType
newtype DefaultEmailOptionType Source #
Constructors
| DefaultEmailOptionType' | |
Fields | |
Bundled Patterns
| pattern DefaultEmailOptionType_CONFIRM_WITH_CODE :: DefaultEmailOptionType | |
| pattern DefaultEmailOptionType_CONFIRM_WITH_LINK :: DefaultEmailOptionType |
Instances
DeliveryMediumType
newtype DeliveryMediumType Source #
Constructors
| DeliveryMediumType' | |
Fields | |
Bundled Patterns
| pattern DeliveryMediumType_EMAIL :: DeliveryMediumType | |
| pattern DeliveryMediumType_SMS :: DeliveryMediumType |
Instances
DeviceRememberedStatusType
newtype DeviceRememberedStatusType Source #
Constructors
| DeviceRememberedStatusType' | |
Fields | |
Bundled Patterns
| pattern DeviceRememberedStatusType_Not_remembered :: DeviceRememberedStatusType | |
| pattern DeviceRememberedStatusType_Remembered :: DeviceRememberedStatusType |
Instances
DomainStatusType
newtype DomainStatusType Source #
Constructors
| DomainStatusType' | |
Fields | |
Bundled Patterns
| pattern DomainStatusType_ACTIVE :: DomainStatusType | |
| pattern DomainStatusType_CREATING :: DomainStatusType | |
| pattern DomainStatusType_DELETING :: DomainStatusType | |
| pattern DomainStatusType_FAILED :: DomainStatusType | |
| pattern DomainStatusType_UPDATING :: DomainStatusType |
Instances
EmailSendingAccountType
newtype EmailSendingAccountType Source #
Constructors
| EmailSendingAccountType' | |
Fields | |
Bundled Patterns
| pattern EmailSendingAccountType_COGNITO_DEFAULT :: EmailSendingAccountType | |
| pattern EmailSendingAccountType_DEVELOPER :: EmailSendingAccountType |
Instances
EventFilterType
newtype EventFilterType Source #
Constructors
| EventFilterType' | |
Fields | |
Bundled Patterns
| pattern EventFilterType_PASSWORD_CHANGE :: EventFilterType | |
| pattern EventFilterType_SIGN_IN :: EventFilterType | |
| pattern EventFilterType_SIGN_UP :: EventFilterType |
Instances
EventResponseType
newtype EventResponseType Source #
Constructors
| EventResponseType' | |
Fields | |
Bundled Patterns
| pattern EventResponseType_Failure :: EventResponseType | |
| pattern EventResponseType_Success :: EventResponseType |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_ForgotPassword :: EventType | |
| pattern EventType_SignIn :: EventType | |
| pattern EventType_SignUp :: EventType |
Instances
ExplicitAuthFlowsType
newtype ExplicitAuthFlowsType Source #
Constructors
| ExplicitAuthFlowsType' | |
Fields | |
Bundled Patterns
Instances
FeedbackValueType
newtype FeedbackValueType Source #
Constructors
| FeedbackValueType' | |
Fields | |
Bundled Patterns
| pattern FeedbackValueType_Invalid :: FeedbackValueType | |
| pattern FeedbackValueType_Valid :: FeedbackValueType |
Instances
IdentityProviderTypeType
newtype IdentityProviderTypeType Source #
Constructors
| IdentityProviderTypeType' | |
Fields | |
Bundled Patterns
Instances
MessageActionType
newtype MessageActionType Source #
Constructors
| MessageActionType' | |
Fields | |
Bundled Patterns
| pattern MessageActionType_RESEND :: MessageActionType | |
| pattern MessageActionType_SUPPRESS :: MessageActionType |
Instances
OAuthFlowType
newtype OAuthFlowType Source #
Constructors
| OAuthFlowType' | |
Fields | |
Bundled Patterns
| pattern OAuthFlowType_Client_credentials :: OAuthFlowType | |
| pattern OAuthFlowType_Code :: OAuthFlowType | |
| pattern OAuthFlowType_Implicit :: OAuthFlowType |
Instances
PreventUserExistenceErrorTypes
newtype PreventUserExistenceErrorTypes Source #
Constructors
| PreventUserExistenceErrorTypes' | |
Fields | |
Bundled Patterns
| pattern PreventUserExistenceErrorTypes_ENABLED :: PreventUserExistenceErrorTypes | |
| pattern PreventUserExistenceErrorTypes_LEGACY :: PreventUserExistenceErrorTypes |
Instances
RecoveryOptionNameType
newtype RecoveryOptionNameType Source #
Constructors
| RecoveryOptionNameType' | |
Fields | |
Bundled Patterns
Instances
RiskDecisionType
newtype RiskDecisionType Source #
Constructors
| RiskDecisionType' | |
Fields | |
Bundled Patterns
| pattern RiskDecisionType_AccountTakeover :: RiskDecisionType | |
| pattern RiskDecisionType_Block :: RiskDecisionType | |
| pattern RiskDecisionType_NoRisk :: RiskDecisionType |
Instances
RiskLevelType
newtype RiskLevelType Source #
Constructors
| RiskLevelType' | |
Fields | |
Bundled Patterns
| pattern RiskLevelType_High :: RiskLevelType | |
| pattern RiskLevelType_Low :: RiskLevelType | |
| pattern RiskLevelType_Medium :: RiskLevelType |
Instances
StatusType
newtype StatusType Source #
Constructors
| StatusType' | |
Fields | |
Bundled Patterns
| pattern StatusType_Disabled :: StatusType | |
| pattern StatusType_Enabled :: StatusType |
Instances
TimeUnitsType
newtype TimeUnitsType Source #
Constructors
| TimeUnitsType' | |
Fields | |
Bundled Patterns
| pattern TimeUnitsType_Days :: TimeUnitsType | |
| pattern TimeUnitsType_Hours :: TimeUnitsType | |
| pattern TimeUnitsType_Minutes :: TimeUnitsType | |
| pattern TimeUnitsType_Seconds :: TimeUnitsType |
Instances
UserImportJobStatusType
newtype UserImportJobStatusType Source #
Constructors
| UserImportJobStatusType' | |
Fields | |
Bundled Patterns
Instances
UserPoolMfaType
newtype UserPoolMfaType Source #
Constructors
| UserPoolMfaType' | |
Fields | |
Bundled Patterns
| pattern UserPoolMfaType_OFF :: UserPoolMfaType | |
| pattern UserPoolMfaType_ON :: UserPoolMfaType | |
| pattern UserPoolMfaType_OPTIONAL :: UserPoolMfaType |
Instances
UserStatusType
newtype UserStatusType Source #
Constructors
| UserStatusType' | |
Fields | |
Bundled Patterns
| pattern UserStatusType_ARCHIVED :: UserStatusType | |
| pattern UserStatusType_COMPROMISED :: UserStatusType | |
| pattern UserStatusType_CONFIRMED :: UserStatusType | |
| pattern UserStatusType_FORCE_CHANGE_PASSWORD :: UserStatusType | |
| pattern UserStatusType_RESET_REQUIRED :: UserStatusType | |
| pattern UserStatusType_UNCONFIRMED :: UserStatusType | |
| pattern UserStatusType_UNKNOWN :: UserStatusType |
Instances
UsernameAttributeType
newtype UsernameAttributeType Source #
Constructors
| UsernameAttributeType' | |
Fields | |
Bundled Patterns
| pattern UsernameAttributeType_Email :: UsernameAttributeType | |
| pattern UsernameAttributeType_Phone_number :: UsernameAttributeType |
Instances
VerifiedAttributeType
newtype VerifiedAttributeType Source #
Constructors
| VerifiedAttributeType' | |
Fields | |
Bundled Patterns
| pattern VerifiedAttributeType_Email :: VerifiedAttributeType | |
| pattern VerifiedAttributeType_Phone_number :: VerifiedAttributeType |
Instances
VerifySoftwareTokenResponseType
newtype VerifySoftwareTokenResponseType Source #
Constructors
| VerifySoftwareTokenResponseType' | |
Fields | |
Bundled Patterns
| pattern VerifySoftwareTokenResponseType_ERROR :: VerifySoftwareTokenResponseType | |
| pattern VerifySoftwareTokenResponseType_SUCCESS :: VerifySoftwareTokenResponseType |
Instances
AccountRecoverySettingType
data AccountRecoverySettingType Source #
The data type for AccountRecoverySetting.
See: newAccountRecoverySettingType smart constructor.
Constructors
| AccountRecoverySettingType' (Maybe (NonEmpty RecoveryOptionType)) |
Instances
newAccountRecoverySettingType :: AccountRecoverySettingType Source #
Create a value of AccountRecoverySettingType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recoveryMechanisms:AccountRecoverySettingType', accountRecoverySettingType_recoveryMechanisms - The list of RecoveryOptionTypes.
AccountTakeoverActionType
data AccountTakeoverActionType Source #
Account takeover action type.
See: newAccountTakeoverActionType smart constructor.
Instances
newAccountTakeoverActionType Source #
Arguments
| :: Bool | |
| -> AccountTakeoverEventActionType | |
| -> AccountTakeoverActionType |
Create a value of AccountTakeoverActionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notify:AccountTakeoverActionType', accountTakeoverActionType_notify - Flag specifying whether to send a notification.
$sel:eventAction:AccountTakeoverActionType', accountTakeoverActionType_eventAction - 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.
AccountTakeoverActionsType
data AccountTakeoverActionsType Source #
Account takeover actions type.
See: newAccountTakeoverActionsType smart constructor.
Constructors
| AccountTakeoverActionsType' (Maybe AccountTakeoverActionType) (Maybe AccountTakeoverActionType) (Maybe AccountTakeoverActionType) |
Instances
newAccountTakeoverActionsType :: AccountTakeoverActionsType Source #
Create a value of AccountTakeoverActionsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lowAction:AccountTakeoverActionsType', accountTakeoverActionsType_lowAction - Action to take for a low risk.
$sel:highAction:AccountTakeoverActionsType', accountTakeoverActionsType_highAction - Action to take for a high risk.
$sel:mediumAction:AccountTakeoverActionsType', accountTakeoverActionsType_mediumAction - Action to take for a medium risk.
AccountTakeoverRiskConfigurationType
data AccountTakeoverRiskConfigurationType Source #
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
See: newAccountTakeoverRiskConfigurationType smart constructor.
Constructors
| AccountTakeoverRiskConfigurationType' (Maybe NotifyConfigurationType) AccountTakeoverActionsType |
Instances
newAccountTakeoverRiskConfigurationType Source #
Create a value of AccountTakeoverRiskConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notifyConfiguration:AccountTakeoverRiskConfigurationType', accountTakeoverRiskConfigurationType_notifyConfiguration - The notify configuration used to construct email notifications.
$sel:actions:AccountTakeoverRiskConfigurationType', accountTakeoverRiskConfigurationType_actions - Account takeover risk configuration actions
AdminCreateUserConfigType
data AdminCreateUserConfigType Source #
The configuration for creating a new user profile.
See: newAdminCreateUserConfigType smart constructor.
Constructors
| AdminCreateUserConfigType' (Maybe Bool) (Maybe Natural) (Maybe MessageTemplateType) |
Instances
newAdminCreateUserConfigType :: AdminCreateUserConfigType Source #
Create a value of AdminCreateUserConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowAdminCreateUserOnly:AdminCreateUserConfigType', adminCreateUserConfigType_allowAdminCreateUserOnly - 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.
$sel:unusedAccountValidityDays:AdminCreateUserConfigType', adminCreateUserConfigType_unusedAccountValidityDays - 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.
If you set a value for TemporaryPasswordValidityDays in
PasswordPolicy, that value will be used and
UnusedAccountValidityDays will be deprecated for that user pool.
$sel:inviteMessageTemplate:AdminCreateUserConfigType', adminCreateUserConfigType_inviteMessageTemplate - The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
AnalyticsConfigurationType
data AnalyticsConfigurationType Source #
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
See: newAnalyticsConfigurationType smart constructor.
Constructors
| AnalyticsConfigurationType' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newAnalyticsConfigurationType :: AnalyticsConfigurationType Source #
Create a value of AnalyticsConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationArn:AnalyticsConfigurationType', analyticsConfigurationType_applicationArn - The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can
use the Amazon Pinpoint project for Pinpoint integration with the chosen
User Pool Client. Amazon Cognito publishes events to the pinpoint
project declared by the app ARN.
$sel:userDataShared:AnalyticsConfigurationType', analyticsConfigurationType_userDataShared - If UserDataShared is true, Amazon Cognito will include user data in
the events it publishes to Amazon Pinpoint analytics.
$sel:applicationId:AnalyticsConfigurationType', analyticsConfigurationType_applicationId - The application ID for an Amazon Pinpoint application.
$sel:externalId:AnalyticsConfigurationType', analyticsConfigurationType_externalId - The external ID.
$sel:roleArn:AnalyticsConfigurationType', analyticsConfigurationType_roleArn - The ARN of an IAM role that authorizes Amazon Cognito to publish events
to Amazon Pinpoint analytics.
AnalyticsMetadataType
data AnalyticsMetadataType Source #
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.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
See: newAnalyticsMetadataType smart constructor.
Constructors
| AnalyticsMetadataType' (Maybe Text) |
Instances
newAnalyticsMetadataType :: AnalyticsMetadataType Source #
Create a value of AnalyticsMetadataType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analyticsEndpointId:AnalyticsMetadataType', analyticsMetadataType_analyticsEndpointId - The endpoint ID.
AttributeType
data AttributeType Source #
Specifies whether the attribute is standard or custom.
See: newAttributeType smart constructor.
Constructors
| AttributeType' (Maybe (Sensitive Text)) Text |
Instances
Arguments
| :: Text | |
| -> AttributeType |
Create a value of AttributeType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:AttributeType', attributeType_value - The value of the attribute.
$sel:name:AttributeType', attributeType_name - The name of the attribute.
AuthEventType
data AuthEventType Source #
The authentication event type.
See: newAuthEventType smart constructor.
Constructors
| AuthEventType' (Maybe EventRiskType) (Maybe EventResponseType) (Maybe EventContextDataType) (Maybe [ChallengeResponseType]) (Maybe EventType) (Maybe POSIX) (Maybe EventFeedbackType) (Maybe Text) |
Instances
newAuthEventType :: AuthEventType Source #
Create a value of AuthEventType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventRisk:AuthEventType', authEventType_eventRisk - The event risk.
$sel:eventResponse:AuthEventType', authEventType_eventResponse - The event response.
$sel:eventContextData:AuthEventType', authEventType_eventContextData - 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.
$sel:challengeResponses:AuthEventType', authEventType_challengeResponses - The challenge responses.
$sel:eventType:AuthEventType', authEventType_eventType - The event type.
$sel:creationDate:AuthEventType', authEventType_creationDate - The creation date
$sel:eventFeedback:AuthEventType', authEventType_eventFeedback - A flag specifying the user feedback captured at the time of an event
request is good or bad.
$sel:eventId:AuthEventType', authEventType_eventId - The event ID.
AuthenticationResultType
data AuthenticationResultType Source #
The authentication result.
See: newAuthenticationResultType smart constructor.
Constructors
| AuthenticationResultType' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe NewDeviceMetadataType) (Maybe Int) (Maybe Text) (Maybe (Sensitive Text)) |
Instances
newAuthenticationResultType :: AuthenticationResultType Source #
Create a value of AuthenticationResultType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:AuthenticationResultType', authenticationResultType_accessToken - The access token.
$sel:refreshToken:AuthenticationResultType', authenticationResultType_refreshToken - The refresh token.
$sel:newDeviceMetadata':AuthenticationResultType', authenticationResultType_newDeviceMetadata - The new device metadata from an authentication result.
$sel:expiresIn:AuthenticationResultType', authenticationResultType_expiresIn - The expiration period of the authentication result in seconds.
$sel:tokenType:AuthenticationResultType', authenticationResultType_tokenType - The token type.
$sel:idToken:AuthenticationResultType', authenticationResultType_idToken - The ID token.
ChallengeResponseType
data ChallengeResponseType Source #
The challenge response type.
See: newChallengeResponseType smart constructor.
Constructors
| ChallengeResponseType' (Maybe ChallengeName) (Maybe ChallengeResponse) |
Instances
newChallengeResponseType :: ChallengeResponseType Source #
Create a value of ChallengeResponseType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:challengeName:ChallengeResponseType', challengeResponseType_challengeName - The challenge name
$sel:challengeResponse:ChallengeResponseType', challengeResponseType_challengeResponse - The challenge response.
CodeDeliveryDetailsType
data CodeDeliveryDetailsType Source #
The code delivery details being returned from the server.
See: newCodeDeliveryDetailsType smart constructor.
Constructors
| CodeDeliveryDetailsType' (Maybe Text) (Maybe DeliveryMediumType) (Maybe Text) |
Instances
newCodeDeliveryDetailsType :: CodeDeliveryDetailsType Source #
Create a value of CodeDeliveryDetailsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:CodeDeliveryDetailsType', codeDeliveryDetailsType_destination - The destination for the code delivery details.
$sel:deliveryMedium:CodeDeliveryDetailsType', codeDeliveryDetailsType_deliveryMedium - The delivery medium (email message or phone number).
$sel:attributeName:CodeDeliveryDetailsType', codeDeliveryDetailsType_attributeName - The attribute name.
CompromisedCredentialsActionsType
data CompromisedCredentialsActionsType Source #
The compromised credentials actions type
See: newCompromisedCredentialsActionsType smart constructor.
Instances
newCompromisedCredentialsActionsType Source #
Create a value of CompromisedCredentialsActionsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventAction:CompromisedCredentialsActionsType', compromisedCredentialsActionsType_eventAction - The event action.
CompromisedCredentialsRiskConfigurationType
data CompromisedCredentialsRiskConfigurationType Source #
The compromised credentials risk configuration type.
See: newCompromisedCredentialsRiskConfigurationType smart constructor.
Constructors
| CompromisedCredentialsRiskConfigurationType' (Maybe [EventFilterType]) CompromisedCredentialsActionsType |
Instances
newCompromisedCredentialsRiskConfigurationType Source #
Create a value of CompromisedCredentialsRiskConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventFilter:CompromisedCredentialsRiskConfigurationType', compromisedCredentialsRiskConfigurationType_eventFilter - Perform the action for these events. The default is to perform all
events if no event filter is specified.
$sel:actions:CompromisedCredentialsRiskConfigurationType', compromisedCredentialsRiskConfigurationType_actions - The compromised credentials risk configuration actions.
ContextDataType
data ContextDataType Source #
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
See: newContextDataType smart constructor.
Constructors
| ContextDataType' (Maybe Text) Text Text Text [HttpHeader] |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ContextDataType |
Create a value of ContextDataType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encodedData:ContextDataType', contextDataType_encodedData - Encoded data containing device fingerprinting details, collected using
the Amazon Cognito context data collection library.
$sel:ipAddress:ContextDataType', contextDataType_ipAddress - Source IP address of your user.
$sel:serverName:ContextDataType', contextDataType_serverName - Your server endpoint where this API is invoked.
$sel:serverPath:ContextDataType', contextDataType_serverPath - Your server path where this API is invoked.
$sel:httpHeaders:ContextDataType', contextDataType_httpHeaders - HttpHeaders received on your server in same order.
CustomDomainConfigType
data CustomDomainConfigType Source #
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
See: newCustomDomainConfigType smart constructor.
Constructors
| CustomDomainConfigType' Text |
Instances
newCustomDomainConfigType Source #
Create a value of CustomDomainConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateArn:CustomDomainConfigType', customDomainConfigType_certificateArn - The Amazon Resource Name (ARN) of an Certificate Manager SSL
certificate. You use this certificate for the subdomain of your custom
domain.
CustomEmailLambdaVersionConfigType
data CustomEmailLambdaVersionConfigType Source #
A custom email sender Lambda configuration type.
See: newCustomEmailLambdaVersionConfigType smart constructor.
Instances
newCustomEmailLambdaVersionConfigType Source #
Arguments
| :: CustomEmailSenderLambdaVersionType | |
| -> Text | |
| -> CustomEmailLambdaVersionConfigType |
Create a value of CustomEmailLambdaVersionConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaVersion:CustomEmailLambdaVersionConfigType', customEmailLambdaVersionConfigType_lambdaVersion - The Lambda version represents the signature of the "request" attribute
in the "event" information Amazon Cognito passes to your custom email
Lambda function. The only supported value is V1_0.
$sel:lambdaArn:CustomEmailLambdaVersionConfigType', customEmailLambdaVersionConfigType_lambdaArn - The Lambda Amazon Resource Name of the Lambda function that Amazon
Cognito triggers to send email notifications to users.
CustomSMSLambdaVersionConfigType
data CustomSMSLambdaVersionConfigType Source #
A custom SMS sender Lambda configuration type.
See: newCustomSMSLambdaVersionConfigType smart constructor.
Instances
newCustomSMSLambdaVersionConfigType Source #
Arguments
| :: CustomSMSSenderLambdaVersionType | |
| -> Text | |
| -> CustomSMSLambdaVersionConfigType |
Create a value of CustomSMSLambdaVersionConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaVersion:CustomSMSLambdaVersionConfigType', customSMSLambdaVersionConfigType_lambdaVersion - The Lambda version represents the signature of the "request" attribute
in the "event" information Amazon Cognito passes to your custom SMS
Lambda function. The only supported value is V1_0.
$sel:lambdaArn:CustomSMSLambdaVersionConfigType', customSMSLambdaVersionConfigType_lambdaArn - The Lambda Amazon Resource Name of the Lambda function that Amazon
Cognito triggers to send SMS notifications to users.
DeviceConfigurationType
data DeviceConfigurationType Source #
The configuration for the user pool's device tracking.
See: newDeviceConfigurationType smart constructor.
Constructors
| DeviceConfigurationType' (Maybe Bool) (Maybe Bool) |
Instances
newDeviceConfigurationType :: DeviceConfigurationType Source #
Create a value of DeviceConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:challengeRequiredOnNewDevice:DeviceConfigurationType', deviceConfigurationType_challengeRequiredOnNewDevice - Indicates whether a challenge is required on a new device. Only
applicable to a new device.
$sel:deviceOnlyRememberedOnUserPrompt:DeviceConfigurationType', deviceConfigurationType_deviceOnlyRememberedOnUserPrompt - If true, a device is only remembered on user prompt.
DeviceSecretVerifierConfigType
data DeviceSecretVerifierConfigType Source #
The device verifier against which it will be authenticated.
See: newDeviceSecretVerifierConfigType smart constructor.
Constructors
| DeviceSecretVerifierConfigType' (Maybe Text) (Maybe Text) |
Instances
newDeviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType Source #
Create a value of DeviceSecretVerifierConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:passwordVerifier:DeviceSecretVerifierConfigType', deviceSecretVerifierConfigType_passwordVerifier - The password verifier.
$sel:salt:DeviceSecretVerifierConfigType', deviceSecretVerifierConfigType_salt - The salt.
DeviceType
data DeviceType Source #
The device type.
See: newDeviceType smart constructor.
Constructors
| DeviceType' (Maybe POSIX) (Maybe POSIX) (Maybe [AttributeType]) (Maybe Text) (Maybe POSIX) |
Instances
newDeviceType :: DeviceType Source #
Create a value of DeviceType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceLastModifiedDate:DeviceType', deviceType_deviceLastModifiedDate - The last modified date of the device.
$sel:deviceCreateDate:DeviceType', deviceType_deviceCreateDate - The creation date of the device.
$sel:deviceAttributes:DeviceType', deviceType_deviceAttributes - The device attributes.
$sel:deviceKey:DeviceType', deviceType_deviceKey - The device key.
$sel:deviceLastAuthenticatedDate:DeviceType', deviceType_deviceLastAuthenticatedDate - The date in which the device was last authenticated.
DomainDescriptionType
data DomainDescriptionType Source #
A container for information about a domain.
See: newDomainDescriptionType smart constructor.
Constructors
| DomainDescriptionType' (Maybe DomainStatusType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CustomDomainConfigType) (Maybe Text) (Maybe Text) |
Instances
newDomainDescriptionType :: DomainDescriptionType Source #
Create a value of DomainDescriptionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DomainDescriptionType', domainDescriptionType_status - The domain status.
$sel:cloudFrontDistribution:DomainDescriptionType', domainDescriptionType_cloudFrontDistribution - The ARN of the CloudFront distribution.
$sel:userPoolId:DomainDescriptionType', domainDescriptionType_userPoolId - The user pool ID.
$sel:domain:DomainDescriptionType', domainDescriptionType_domain - The domain string.
$sel:aWSAccountId:DomainDescriptionType', domainDescriptionType_aWSAccountId - The account ID for the user pool owner.
$sel:customDomainConfig:DomainDescriptionType', domainDescriptionType_customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in
webpages for your application.
$sel:version:DomainDescriptionType', domainDescriptionType_version - The app version.
$sel:s3Bucket:DomainDescriptionType', domainDescriptionType_s3Bucket - The S3 bucket where the static files for this domain are stored.
EmailConfigurationType
data EmailConfigurationType Source #
The email configuration type.
Amazon Cognito has specific regions for use with Amazon SES. For more information on the supported regions, see Email Settings for Amazon Cognito User Pools.
See: newEmailConfigurationType smart constructor.
Constructors
| EmailConfigurationType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EmailSendingAccountType) |
Instances
newEmailConfigurationType :: EmailConfigurationType Source #
Create a value of EmailConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceArn:EmailConfigurationType', emailConfigurationType_sourceArn - The Amazon Resource Name (ARN) of a verified email address in Amazon
SES. This email address is used in one of the following ways, depending
on the value that you specify for the EmailSendingAccount parameter:
- If you specify
COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account. - If you specify
DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
$sel:from:EmailConfigurationType', emailConfigurationType_from - Identifies either the sender’s email address or the sender’s name with
their email address. For example, testuser@example.com or
Test User <testuser@example.com>. This address will appear before
the body of the email.
$sel:configurationSet:EmailConfigurationType', emailConfigurationType_configurationSet - The set of configuration rules that can be applied to emails sent using
Amazon SES. A configuration set is applied to an email by including a
reference to the configuration set in the headers of the email. Once
applied, all of the rules in that configuration set are applied to the
email. Configuration sets can be used to apply the following types of
rules to emails:
- Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as SNS and CloudWatch.
- IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
$sel:replyToEmailAddress:EmailConfigurationType', emailConfigurationType_replyToEmailAddress - The destination to which the receiver of the email should reply to.
$sel:emailSendingAccount:EmailConfigurationType', emailConfigurationType_emailSendingAccount - Specifies whether Amazon Cognito emails your users by using its built-in
email functionality or your Amazon SES email configuration. Specify one
of the following values:
- COGNITO_DEFAULT
- When Amazon Cognito emails your users, it uses its built-in email
functionality. When you use the default option, Amazon Cognito
allows only a limited number of emails each day for your user pool.
For typical production environments, the default email limit is
below the required delivery volume. To achieve a higher delivery
volume, specify DEVELOPER to use your Amazon SES email
configuration.
To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide.
The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the
SourceArnparameter.If EmailSendingAccount is COGNITO_DEFAULT, the following parameters aren't allowed:
- EmailVerificationMessage
- EmailVerificationSubject
- InviteMessageTemplate.EmailMessage
- InviteMessageTemplate.EmailSubject
- VerificationMessageTemplate.EmailMessage
- VerificationMessageTemplate.EmailMessageByLink
- VerificationMessageTemplate.EmailSubject,
- VerificationMessageTemplate.EmailSubjectByLink
DEVELOPER EmailSendingAccount is required.
- DEVELOPER
- When Amazon Cognito emails your users, it uses your Amazon SES
configuration. Amazon Cognito calls Amazon SES on your behalf to
send email from your verified email address. When you use this
option, the email delivery limits are the same limits that apply to
your Amazon SES verified email address in your account.
If you use this option, you must provide the ARN of an Amazon SES verified email address for the
SourceArnparameter.Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a /service-linked role/, which is a type of IAM role, in your account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
EventContextDataType
data EventContextDataType Source #
Specifies the user context data captured at the time of an event request.
See: newEventContextDataType smart constructor.
Instances
newEventContextDataType :: EventContextDataType Source #
Create a value of EventContextDataType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipAddress:EventContextDataType', eventContextDataType_ipAddress - The user's IP address.
$sel:country:EventContextDataType', eventContextDataType_country - The user's country.
$sel:city:EventContextDataType', eventContextDataType_city - The user's city.
$sel:deviceName:EventContextDataType', eventContextDataType_deviceName - The user's device name.
$sel:timezone:EventContextDataType', eventContextDataType_timezone - The user's time zone.
EventFeedbackType
data EventFeedbackType Source #
Specifies the event feedback type.
See: newEventFeedbackType smart constructor.
Constructors
| EventFeedbackType' (Maybe POSIX) FeedbackValueType Text |
Instances
Arguments
| :: FeedbackValueType | |
| -> Text | |
| -> EventFeedbackType |
Create a value of EventFeedbackType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:feedbackDate:EventFeedbackType', eventFeedbackType_feedbackDate - The event feedback date.
$sel:feedbackValue:EventFeedbackType', eventFeedbackType_feedbackValue - The event feedback value.
$sel:provider:EventFeedbackType', eventFeedbackType_provider - The provider.
EventRiskType
data EventRiskType Source #
The event risk type.
See: newEventRiskType smart constructor.
Constructors
| EventRiskType' (Maybe Bool) (Maybe RiskLevelType) (Maybe RiskDecisionType) |
Instances
newEventRiskType :: EventRiskType Source #
Create a value of EventRiskType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:compromisedCredentialsDetected:EventRiskType', eventRiskType_compromisedCredentialsDetected - Indicates whether compromised credentials were detected during an
authentication event.
$sel:riskLevel:EventRiskType', eventRiskType_riskLevel - The risk level.
$sel:riskDecision:EventRiskType', eventRiskType_riskDecision - The risk decision.
GroupType
The group type.
See: newGroupType smart constructor.
Constructors
| GroupType' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newGroupType :: GroupType Source #
Create a value of GroupType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedDate:GroupType', groupType_lastModifiedDate - The date the group was last modified.
$sel:userPoolId:GroupType', groupType_userPoolId - The user pool ID for the user pool.
$sel:creationDate:GroupType', groupType_creationDate - The date the group was created.
$sel:precedence:GroupType', groupType_precedence - 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.
$sel:groupName:GroupType', groupType_groupName - The name of the group.
$sel:description:GroupType', groupType_description - A string containing the description of the group.
$sel:roleArn:GroupType', groupType_roleArn - The role ARN for the group.
HttpHeader
data HttpHeader Source #
The HTTP header.
See: newHttpHeader smart constructor.
Constructors
| HttpHeader' (Maybe Text) (Maybe Text) |
Instances
newHttpHeader :: HttpHeader Source #
Create a value of HttpHeader with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:headerValue:HttpHeader', httpHeader_headerValue - The header value.
$sel:headerName:HttpHeader', httpHeader_headerName - The header name
IdentityProviderType
data IdentityProviderType Source #
A container for information about an identity provider.
See: newIdentityProviderType smart constructor.
Constructors
| IdentityProviderType' (Maybe POSIX) (Maybe Text) (Maybe IdentityProviderTypeType) (Maybe POSIX) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) |
Instances
newIdentityProviderType :: IdentityProviderType Source #
Create a value of IdentityProviderType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedDate:IdentityProviderType', identityProviderType_lastModifiedDate - The date the identity provider was last modified.
$sel:userPoolId:IdentityProviderType', identityProviderType_userPoolId - The user pool ID.
$sel:providerType:IdentityProviderType', identityProviderType_providerType - The identity provider type.
$sel:creationDate:IdentityProviderType', identityProviderType_creationDate - The date the identity provider was created.
$sel:idpIdentifiers:IdentityProviderType', identityProviderType_idpIdentifiers - A list of identity provider identifiers.
$sel:attributeMapping:IdentityProviderType', identityProviderType_attributeMapping - A mapping of identity provider attributes to standard and custom user
pool attributes.
$sel:providerDetails:IdentityProviderType', identityProviderType_providerDetails - The identity provider details. The following list describes the provider
detail keys for each identity provider type.
For Google and Login with Amazon:
- client_id
- client_secret
- authorize_scopes
For Facebook:
- client_id
- client_secret
- authorize_scopes
- api_version
For Sign in with Apple:
- client_id
- team_id
- key_id
- private_key
- authorize_scopes
For OIDC providers:
- client_id
- client_secret
- attributes_request_method
- oidc_issuer
- authorize_scopes
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignOut optional
$sel:providerName:IdentityProviderType', identityProviderType_providerName - The identity provider name.
LambdaConfigType
data LambdaConfigType Source #
Specifies the configuration for Lambda triggers.
See: newLambdaConfigType smart constructor.
Constructors
| LambdaConfigType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CustomSMSLambdaVersionConfigType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CustomEmailLambdaVersionConfigType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newLambdaConfigType :: LambdaConfigType Source #
Create a value of LambdaConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:preAuthentication:LambdaConfigType', lambdaConfigType_preAuthentication - A pre-authentication Lambda trigger.
$sel:createAuthChallenge:LambdaConfigType', lambdaConfigType_createAuthChallenge - Creates an authentication challenge.
$sel:verifyAuthChallengeResponse:LambdaConfigType', lambdaConfigType_verifyAuthChallengeResponse - Verifies the authentication challenge response.
$sel:customSMSSender:LambdaConfigType', lambdaConfigType_customSMSSender - A custom SMS sender Lambda trigger.
$sel:postAuthentication:LambdaConfigType', lambdaConfigType_postAuthentication - A post-authentication Lambda trigger.
$sel:customMessage:LambdaConfigType', lambdaConfigType_customMessage - A custom Message Lambda trigger.
$sel:defineAuthChallenge:LambdaConfigType', lambdaConfigType_defineAuthChallenge - Defines the authentication challenge.
$sel:customEmailSender:LambdaConfigType', lambdaConfigType_customEmailSender - A custom email sender Lambda trigger.
$sel:kmsKeyID:LambdaConfigType', lambdaConfigType_kmsKeyID - The Amazon Resource Name of Key Management Service
Customer master keys
. Amazon Cognito uses the key to encrypt codes and temporary passwords
sent to CustomEmailSender and CustomSMSSender.
$sel:postConfirmation:LambdaConfigType', lambdaConfigType_postConfirmation - A post-confirmation Lambda trigger.
$sel:preTokenGeneration:LambdaConfigType', lambdaConfigType_preTokenGeneration - A Lambda trigger that is invoked before token generation.
$sel:userMigration:LambdaConfigType', lambdaConfigType_userMigration - The user migration Lambda config type.
$sel:preSignUp:LambdaConfigType', lambdaConfigType_preSignUp - A pre-registration Lambda trigger.
MFAOptionType
data MFAOptionType Source #
This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.
See: newMFAOptionType smart constructor.
Constructors
| MFAOptionType' (Maybe DeliveryMediumType) (Maybe Text) |
Instances
newMFAOptionType :: MFAOptionType Source #
Create a value of MFAOptionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deliveryMedium:MFAOptionType', mfaOptionType_deliveryMedium - The delivery medium to send the MFA code. You can use this parameter to
set only the SMS delivery medium value.
$sel:attributeName:MFAOptionType', mfaOptionType_attributeName - The attribute name of the MFA option type. The only valid value is
phone_number.
MessageTemplateType
data MessageTemplateType Source #
The message template structure.
See: newMessageTemplateType smart constructor.
Instances
newMessageTemplateType :: MessageTemplateType Source #
Create a value of MessageTemplateType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emailSubject:MessageTemplateType', messageTemplateType_emailSubject - The subject line for email messages. EmailSubject is allowed only if
EmailSendingAccount
is DEVELOPER.
$sel:sMSMessage:MessageTemplateType', messageTemplateType_sMSMessage - The message template for SMS messages.
$sel:emailMessage:MessageTemplateType', messageTemplateType_emailMessage - The message template for email messages. EmailMessage is allowed only if
EmailSendingAccount
is DEVELOPER.
NewDeviceMetadataType
data NewDeviceMetadataType Source #
The new device metadata type.
See: newNewDeviceMetadataType smart constructor.
Constructors
| NewDeviceMetadataType' (Maybe Text) (Maybe Text) |
Instances
newNewDeviceMetadataType :: NewDeviceMetadataType Source #
Create a value of NewDeviceMetadataType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceGroupKey:NewDeviceMetadataType', newDeviceMetadataType_deviceGroupKey - The device group key.
$sel:deviceKey:NewDeviceMetadataType', newDeviceMetadataType_deviceKey - The device key.
NotifyConfigurationType
data NotifyConfigurationType Source #
The notify configuration type.
See: newNotifyConfigurationType smart constructor.
Constructors
| NotifyConfigurationType' (Maybe NotifyEmailType) (Maybe Text) (Maybe Text) (Maybe NotifyEmailType) (Maybe NotifyEmailType) Text |
Instances
newNotifyConfigurationType Source #
Create a value of NotifyConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:noActionEmail:NotifyConfigurationType', notifyConfigurationType_noActionEmail - The email template used when a detected risk event is allowed.
$sel:from:NotifyConfigurationType', notifyConfigurationType_from - 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.
$sel:replyTo:NotifyConfigurationType', notifyConfigurationType_replyTo - The destination to which the receiver of an email should reply to.
$sel:blockEmail:NotifyConfigurationType', notifyConfigurationType_blockEmail - Email template used when a detected risk event is blocked.
$sel:mfaEmail:NotifyConfigurationType', notifyConfigurationType_mfaEmail - The MFA email template used when MFA is challenged as part of a detected
risk.
$sel:sourceArn:NotifyConfigurationType', notifyConfigurationType_sourceArn - 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 Source #
The notify email type.
See: newNotifyEmailType smart constructor.
Instances
Arguments
| :: Text | |
| -> NotifyEmailType |
Create a value of NotifyEmailType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textBody:NotifyEmailType', notifyEmailType_textBody - The text body.
$sel:htmlBody:NotifyEmailType', notifyEmailType_htmlBody - The HTML body.
$sel:subject:NotifyEmailType', notifyEmailType_subject - The subject.
NumberAttributeConstraintsType
data NumberAttributeConstraintsType Source #
The minimum and maximum value of an attribute that is of the number data type.
See: newNumberAttributeConstraintsType smart constructor.
Constructors
| NumberAttributeConstraintsType' (Maybe Text) (Maybe Text) |
Instances
newNumberAttributeConstraintsType :: NumberAttributeConstraintsType Source #
Create a value of NumberAttributeConstraintsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxValue:NumberAttributeConstraintsType', numberAttributeConstraintsType_maxValue - The maximum value of an attribute that is of the number data type.
$sel:minValue:NumberAttributeConstraintsType', numberAttributeConstraintsType_minValue - The minimum value of an attribute that is of the number data type.
PasswordPolicyType
data PasswordPolicyType Source #
The password policy type.
See: newPasswordPolicyType smart constructor.
Constructors
| PasswordPolicyType' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Bool) (Maybe Natural) |
Instances
newPasswordPolicyType :: PasswordPolicyType Source #
Create a value of PasswordPolicyType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requireNumbers:PasswordPolicyType', passwordPolicyType_requireNumbers - In the password policy that you have set, refers to whether you have
required users to use at least one number in their password.
$sel:requireUppercase:PasswordPolicyType', passwordPolicyType_requireUppercase - 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.
$sel:requireLowercase:PasswordPolicyType', passwordPolicyType_requireLowercase - 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.
$sel:minimumLength:PasswordPolicyType', passwordPolicyType_minimumLength - The minimum length of the password policy that you have set. Cannot be
less than 6.
$sel:requireSymbols:PasswordPolicyType', passwordPolicyType_requireSymbols - In the password policy that you have set, refers to whether you have
required users to use at least one symbol in their password.
$sel:temporaryPasswordValidityDays:PasswordPolicyType', passwordPolicyType_temporaryPasswordValidityDays - In the password policy you have set, refers to the number of days a
temporary password is valid. If the user does not sign-in during this
time, their password will need to be reset by an administrator.
When you set TemporaryPasswordValidityDays for a user pool, you will
no longer be able to set the deprecated UnusedAccountValidityDays
value for that user pool.
ProviderDescription
data ProviderDescription Source #
A container for identity provider details.
See: newProviderDescription smart constructor.
Constructors
| ProviderDescription' (Maybe POSIX) (Maybe IdentityProviderTypeType) (Maybe POSIX) (Maybe Text) |
Instances
newProviderDescription :: ProviderDescription Source #
Create a value of ProviderDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedDate:ProviderDescription', providerDescription_lastModifiedDate - The date the provider was last modified.
$sel:providerType:ProviderDescription', providerDescription_providerType - The identity provider type.
$sel:creationDate:ProviderDescription', providerDescription_creationDate - The date the provider was added to the user pool.
$sel:providerName:ProviderDescription', providerDescription_providerName - The identity provider name.
ProviderUserIdentifierType
data ProviderUserIdentifierType Source #
A container for information about an identity provider for a user pool.
See: newProviderUserIdentifierType smart constructor.
Instances
newProviderUserIdentifierType :: ProviderUserIdentifierType Source #
Create a value of ProviderUserIdentifierType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:providerAttributeValue:ProviderUserIdentifierType', providerUserIdentifierType_providerAttributeValue - The value of the provider attribute to link to, for example,
xxxxx_account.
$sel:providerAttributeName:ProviderUserIdentifierType', providerUserIdentifierType_providerAttributeName - The name of the provider attribute to link to, for example, NameID.
$sel:providerName:ProviderUserIdentifierType', providerUserIdentifierType_providerName - The name of the provider, for example, Facebook, Google, or Login with
Amazon.
RecoveryOptionType
data RecoveryOptionType Source #
A map containing a priority as a key, and recovery method name as a value.
See: newRecoveryOptionType smart constructor.
Constructors
| RecoveryOptionType' Natural RecoveryOptionNameType |
Instances
newRecoveryOptionType Source #
Arguments
| :: Natural | |
| -> RecoveryOptionNameType | |
| -> RecoveryOptionType |
Create a value of RecoveryOptionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:priority:RecoveryOptionType', recoveryOptionType_priority - A positive integer specifying priority of a method with 1 being the
highest priority.
$sel:name:RecoveryOptionType', recoveryOptionType_name - Specifies the recovery method for a user.
ResourceServerScopeType
data ResourceServerScopeType Source #
A resource server scope.
See: newResourceServerScopeType smart constructor.
Constructors
| ResourceServerScopeType' Text Text |
Instances
newResourceServerScopeType Source #
Arguments
| :: Text | |
| -> Text | |
| -> ResourceServerScopeType |
Create a value of ResourceServerScopeType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scopeName:ResourceServerScopeType', resourceServerScopeType_scopeName - The name of the scope.
$sel:scopeDescription:ResourceServerScopeType', resourceServerScopeType_scopeDescription - A description of the scope.
ResourceServerType
data ResourceServerType Source #
A container for information about a resource server for a user pool.
See: newResourceServerType smart constructor.
Constructors
| ResourceServerType' (Maybe Text) (Maybe Text) (Maybe [ResourceServerScopeType]) (Maybe Text) |
Instances
newResourceServerType :: ResourceServerType Source #
Create a value of ResourceServerType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolId:ResourceServerType', resourceServerType_userPoolId - The user pool ID for the user pool that hosts the resource server.
$sel:identifier:ResourceServerType', resourceServerType_identifier - The identifier for the resource server.
$sel:scopes:ResourceServerType', resourceServerType_scopes - A list of scopes that are defined for the resource server.
$sel:name:ResourceServerType', resourceServerType_name - The name of the resource server.
RiskConfigurationType
data RiskConfigurationType Source #
The risk configuration type.
See: newRiskConfigurationType smart constructor.
Constructors
Instances
newRiskConfigurationType :: RiskConfigurationType Source #
Create a value of RiskConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:riskExceptionConfiguration:RiskConfigurationType', riskConfigurationType_riskExceptionConfiguration - The configuration to override the risk decision.
$sel:clientId:RiskConfigurationType', riskConfigurationType_clientId - The app client ID.
$sel:accountTakeoverRiskConfiguration:RiskConfigurationType', riskConfigurationType_accountTakeoverRiskConfiguration - The account takeover risk configuration object including the
NotifyConfiguration object and Actions to take in the case of an
account takeover.
$sel:lastModifiedDate:RiskConfigurationType', riskConfigurationType_lastModifiedDate - The last modified date.
$sel:userPoolId:RiskConfigurationType', riskConfigurationType_userPoolId - The user pool ID.
$sel:compromisedCredentialsRiskConfiguration:RiskConfigurationType', riskConfigurationType_compromisedCredentialsRiskConfiguration - The compromised credentials risk configuration object including the
EventFilter and the EventAction
RiskExceptionConfigurationType
data RiskExceptionConfigurationType Source #
The type of the configuration to override the risk decision.
See: newRiskExceptionConfigurationType smart constructor.
Constructors
| RiskExceptionConfigurationType' (Maybe [Text]) (Maybe [Text]) |
Instances
newRiskExceptionConfigurationType :: RiskExceptionConfigurationType Source #
Create a value of RiskExceptionConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:skippedIPRangeList:RiskExceptionConfigurationType', riskExceptionConfigurationType_skippedIPRangeList - Risk detection is not performed on the IP addresses in the range list.
The IP range is in CIDR notation.
$sel:blockedIPRangeList:RiskExceptionConfigurationType', riskExceptionConfigurationType_blockedIPRangeList - 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 Source #
The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.
See: newSMSMfaSettingsType smart constructor.
Constructors
| SMSMfaSettingsType' (Maybe Bool) (Maybe Bool) |
Instances
newSMSMfaSettingsType :: SMSMfaSettingsType Source #
Create a value of SMSMfaSettingsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:SMSMfaSettingsType', sMSMfaSettingsType_enabled - Specifies whether SMS text message MFA is enabled. If an MFA type is
enabled for a user, the user will be prompted for MFA during all sign in
attempts, unless device tracking is turned on and the device has been
trusted.
$sel:preferredMfa:SMSMfaSettingsType', sMSMfaSettingsType_preferredMfa - Specifies whether SMS is the preferred MFA method.
SchemaAttributeType
data SchemaAttributeType Source #
Contains information about the schema attribute.
See: newSchemaAttributeType smart constructor.
Constructors
| SchemaAttributeType' (Maybe NumberAttributeConstraintsType) (Maybe Bool) (Maybe AttributeDataType) (Maybe StringAttributeConstraintsType) (Maybe Text) (Maybe Bool) (Maybe Bool) |
Instances
newSchemaAttributeType :: SchemaAttributeType Source #
Create a value of SchemaAttributeType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numberAttributeConstraints:SchemaAttributeType', schemaAttributeType_numberAttributeConstraints - Specifies the constraints for an attribute of the number type.
$sel:required:SchemaAttributeType', schemaAttributeType_required - 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.
$sel:attributeDataType:SchemaAttributeType', schemaAttributeType_attributeDataType - The attribute data type.
$sel:stringAttributeConstraints:SchemaAttributeType', schemaAttributeType_stringAttributeConstraints - Specifies the constraints for an attribute of the string type.
$sel:name:SchemaAttributeType', schemaAttributeType_name - A schema attribute of the name type.
$sel:developerOnlyAttribute:SchemaAttributeType', schemaAttributeType_developerOnlyAttribute - We recommend that you use
WriteAttributes
in the user pool client to control how attributes can be mutated for new
use cases instead of using DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute
can only be modified by an administrator. Users will not be able to
modify this attribute using their access token. For example,
DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes
but cannot be updated using UpdateUserAttributes.
$sel:mutable:SchemaAttributeType', schemaAttributeType_mutable - Specifies whether the value of the attribute can be changed.
For any user pool attribute that's mapped to an identity provider
attribute, you must set this parameter to true. Amazon Cognito updates
mapped attributes when users sign in to your application through an
identity provider. If an attribute is immutable, Amazon Cognito throws
an error when it attempts to update the attribute. For more information,
see
Specifying Identity Provider Attribute Mappings for Your User Pool.
SmsConfigurationType
data SmsConfigurationType Source #
The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your account. The Cognito User Pool makes the request to the Amazon SNS Service by using an IAM role that you provide for your account.
See: newSmsConfigurationType smart constructor.
Constructors
| SmsConfigurationType' (Maybe Text) Text |
Instances
newSmsConfigurationType Source #
Create a value of SmsConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalId:SmsConfigurationType', smsConfigurationType_externalId - The external ID is a value that we recommend you use to add security to
your IAM role which is used to call Amazon SNS to send SMS messages for
your user pool. If you provide an ExternalId, the Cognito User Pool
will include it when attempting to assume your IAM role, so that you can
set your roles trust policy to require the ExternalID. If you use the
Cognito Management Console to create a role for SMS MFA, Cognito will
create a role with the required permissions and a trust policy that
demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see
How to use an external ID when granting access to your Amazon Web Services resources to a third party
$sel:snsCallerArn:SmsConfigurationType', smsConfigurationType_snsCallerArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(SNS) caller. This is the ARN of the IAM role in your account which
Cognito will use to send SMS messages. SMS messages are subject to a
spending limit.
SmsMfaConfigType
data SmsMfaConfigType Source #
The SMS text message multi-factor authentication (MFA) configuration type.
See: newSmsMfaConfigType smart constructor.
Constructors
| SmsMfaConfigType' (Maybe Text) (Maybe SmsConfigurationType) |
Instances
newSmsMfaConfigType :: SmsMfaConfigType Source #
Create a value of SmsMfaConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:smsAuthenticationMessage:SmsMfaConfigType', smsMfaConfigType_smsAuthenticationMessage - The SMS authentication message that will be sent to users with the code
they need to sign in. The message must contain the ‘{####}’ placeholder,
which will be replaced with the code. If the message is not included,
and default message will be used.
$sel:smsConfiguration:SmsMfaConfigType', smsMfaConfigType_smsConfiguration - The SMS configuration.
SoftwareTokenMfaConfigType
data SoftwareTokenMfaConfigType Source #
The type used for enabling software token MFA at the user pool level.
See: newSoftwareTokenMfaConfigType smart constructor.
Constructors
| SoftwareTokenMfaConfigType' (Maybe Bool) |
Instances
newSoftwareTokenMfaConfigType :: SoftwareTokenMfaConfigType Source #
Create a value of SoftwareTokenMfaConfigType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:SoftwareTokenMfaConfigType', softwareTokenMfaConfigType_enabled - Specifies whether software token MFA is enabled.
SoftwareTokenMfaSettingsType
data SoftwareTokenMfaSettingsType Source #
The type used for enabling software token MFA at the user level. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.
See: newSoftwareTokenMfaSettingsType smart constructor.
Constructors
| SoftwareTokenMfaSettingsType' (Maybe Bool) (Maybe Bool) |
Instances
newSoftwareTokenMfaSettingsType :: SoftwareTokenMfaSettingsType Source #
Create a value of SoftwareTokenMfaSettingsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:SoftwareTokenMfaSettingsType', softwareTokenMfaSettingsType_enabled - Specifies whether software token MFA is enabled. If an MFA type is
enabled for a user, the user will be prompted for MFA during all sign in
attempts, unless device tracking is turned on and the device has been
trusted.
$sel:preferredMfa:SoftwareTokenMfaSettingsType', softwareTokenMfaSettingsType_preferredMfa - Specifies whether software token MFA is the preferred MFA method.
StringAttributeConstraintsType
data StringAttributeConstraintsType Source #
The constraints associated with a string attribute.
See: newStringAttributeConstraintsType smart constructor.
Constructors
| StringAttributeConstraintsType' (Maybe Text) (Maybe Text) |
Instances
newStringAttributeConstraintsType :: StringAttributeConstraintsType Source #
Create a value of StringAttributeConstraintsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxLength:StringAttributeConstraintsType', stringAttributeConstraintsType_maxLength - The maximum length.
$sel:minLength:StringAttributeConstraintsType', stringAttributeConstraintsType_minLength - The minimum length.
TokenValidityUnitsType
data TokenValidityUnitsType Source #
The data type for TokenValidityUnits that specifics the time measurements for token validity.
See: newTokenValidityUnitsType smart constructor.
Constructors
| TokenValidityUnitsType' (Maybe TimeUnitsType) (Maybe TimeUnitsType) (Maybe TimeUnitsType) |
Instances
newTokenValidityUnitsType :: TokenValidityUnitsType Source #
Create a value of TokenValidityUnitsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:TokenValidityUnitsType', tokenValidityUnitsType_accessToken - A time unit in “seconds”, “minutes”, “hours” or “days” for the value in
AccessTokenValidity, defaults to hours.
$sel:refreshToken:TokenValidityUnitsType', tokenValidityUnitsType_refreshToken - A time unit in “seconds”, “minutes”, “hours” or “days” for the value in
RefreshTokenValidity, defaults to days.
$sel:idToken:TokenValidityUnitsType', tokenValidityUnitsType_idToken - A time unit in “seconds”, “minutes”, “hours” or “days” for the value in
IdTokenValidity, defaults to hours.
UICustomizationType
data UICustomizationType Source #
A container for the UI customization information for a user pool's built-in app UI.
See: newUICustomizationType smart constructor.
Constructors
| UICustomizationType' (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newUICustomizationType :: UICustomizationType Source #
Create a value of UICustomizationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:UICustomizationType', uICustomizationType_clientId - The client ID for the client app.
$sel:lastModifiedDate:UICustomizationType', uICustomizationType_lastModifiedDate - The last-modified date for the UI customization.
$sel:userPoolId:UICustomizationType', uICustomizationType_userPoolId - The user pool ID for the user pool.
$sel:css:UICustomizationType', uICustomizationType_css - The CSS values in the UI customization.
$sel:cSSVersion:UICustomizationType', uICustomizationType_cSSVersion - The CSS version number.
$sel:imageUrl:UICustomizationType', uICustomizationType_imageUrl - The logo image for the UI customization.
$sel:creationDate:UICustomizationType', uICustomizationType_creationDate - The creation date for the UI customization.
UserContextDataType
data UserContextDataType Source #
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: newUserContextDataType smart constructor.
Constructors
| UserContextDataType' (Maybe Text) |
Instances
newUserContextDataType :: UserContextDataType Source #
Create a value of UserContextDataType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encodedData:UserContextDataType', userContextDataType_encodedData - 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 Source #
The user import job type.
See: newUserImportJobType smart constructor.
Constructors
| UserImportJobType' (Maybe UserImportJobStatusType) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Integer) |
Instances
newUserImportJobType :: UserImportJobType Source #
Create a value of UserImportJobType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:UserImportJobType', userImportJobType_status - 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.
$sel:skippedUsers:UserImportJobType', userImportJobType_skippedUsers - The number of users that were skipped.
$sel:jobId:UserImportJobType', userImportJobType_jobId - The job ID for the user import job.
$sel:userPoolId:UserImportJobType', userImportJobType_userPoolId - The user pool ID for the user pool that the users are being imported
into.
$sel:jobName:UserImportJobType', userImportJobType_jobName - The job name for the user import job.
$sel:preSignedUrl:UserImportJobType', userImportJobType_preSignedUrl - The pre-signed URL to be used to upload the .csv file.
$sel:failedUsers:UserImportJobType', userImportJobType_failedUsers - The number of users that could not be imported.
$sel:startDate:UserImportJobType', userImportJobType_startDate - The date when the user import job was started.
$sel:completionMessage:UserImportJobType', userImportJobType_completionMessage - The message returned when the user import job is completed.
$sel:creationDate:UserImportJobType', userImportJobType_creationDate - The date the user import job was created.
$sel:completionDate:UserImportJobType', userImportJobType_completionDate - The date when the user import job was completed.
$sel:cloudWatchLogsRoleArn:UserImportJobType', userImportJobType_cloudWatchLogsRoleArn - 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.
$sel:importedUsers:UserImportJobType', userImportJobType_importedUsers - The number of users that were successfully imported.
UserPoolAddOnsType
data UserPoolAddOnsType Source #
The user pool add-ons type.
See: newUserPoolAddOnsType smart constructor.
Constructors
| UserPoolAddOnsType' AdvancedSecurityModeType |
Instances
newUserPoolAddOnsType Source #
Arguments
| :: AdvancedSecurityModeType | |
| -> UserPoolAddOnsType |
Create a value of UserPoolAddOnsType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:advancedSecurityMode:UserPoolAddOnsType', userPoolAddOnsType_advancedSecurityMode - The advanced security mode.
UserPoolClientDescription
data UserPoolClientDescription Source #
The description of the user pool client.
See: newUserPoolClientDescription smart constructor.
Instances
newUserPoolClientDescription :: UserPoolClientDescription Source #
Create a value of UserPoolClientDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:UserPoolClientDescription', userPoolClientDescription_clientId - The ID of the client associated with the user pool.
$sel:userPoolId:UserPoolClientDescription', userPoolClientDescription_userPoolId - The user pool ID for the user pool where you want to describe the user
pool client.
$sel:clientName:UserPoolClientDescription', userPoolClientDescription_clientName - The client name from the user pool client description.
UserPoolClientType
data UserPoolClientType Source #
Contains information about a user pool client.
See: newUserPoolClientType smart constructor.
Constructors
| UserPoolClientType' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe [ExplicitAuthFlowsType]) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe TokenValidityUnitsType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe PreventUserExistenceErrorTypes) (Maybe Natural) (Maybe POSIX) (Maybe [Text]) (Maybe [Text]) (Maybe [OAuthFlowType]) (Maybe AnalyticsConfigurationType) (Maybe Text) (Maybe [Text]) |
Instances
newUserPoolClientType :: UserPoolClientType Source #
Create a value of UserPoolClientType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:refreshTokenValidity:UserPoolClientType', userPoolClientType_refreshTokenValidity - The time limit, in days, after which the refresh token is no longer
valid and cannot be used.
$sel:clientId:UserPoolClientType', userPoolClientType_clientId - The ID of the client associated with the user pool.
$sel:explicitAuthFlows:UserPoolClientType', userPoolClientType_explicitAuthFlows - The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor of new
names with the ALLOW_ prefix. Note that values with ALLOW_ prefix
cannot be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH. This setting replaces theADMIN_NO_SRP_AUTHsetting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH: Enable SRP based authentication.ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
$sel:clientSecret:UserPoolClientType', userPoolClientType_clientSecret - The client secret from the user pool request of the client type.
$sel:lastModifiedDate:UserPoolClientType', userPoolClientType_lastModifiedDate - The date the user pool client was last modified.
$sel:supportedIdentityProviders:UserPoolClientType', userPoolClientType_supportedIdentityProviders - A list of provider names for the identity providers that are supported
on this client.
$sel:logoutURLs:UserPoolClientType', userPoolClientType_logoutURLs - A list of allowed logout URLs for the identity providers.
$sel:allowedOAuthFlowsUserPoolClient:UserPoolClientType', userPoolClientType_allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
$sel:userPoolId:UserPoolClientType', userPoolClientType_userPoolId - The user pool ID for the user pool client.
$sel:idTokenValidity:UserPoolClientType', userPoolClientType_idTokenValidity - The time limit, specified by tokenValidityUnits, defaulting to hours,
after which the refresh token is no longer valid and cannot be used.
$sel:tokenValidityUnits:UserPoolClientType', userPoolClientType_tokenValidityUnits - The time units used to specify the token validity times of their
respective token.
$sel:defaultRedirectURI:UserPoolClientType', userPoolClientType_defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
$sel:enableTokenRevocation:UserPoolClientType', userPoolClientType_enableTokenRevocation - Indicates whether token revocation is enabled for the user pool client.
When you create a new user pool client, token revocation is enabled by
default. For more information about revoking tokens, see
RevokeToken.
$sel:writeAttributes:UserPoolClientType', userPoolClientType_writeAttributes - The writeable attributes.
$sel:preventUserExistenceErrors:UserPoolClientType', userPoolClientType_preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and account
confirmation and password recovery return a response indicating a code
was sent to a simulated destination. When set to LEGACY, those APIs
will return a UserNotFoundException exception if the user does not
exist in the user pool.
Valid values include:
ENABLED- This prevents user existence-related errors.LEGACY- This represents the old behavior of Cognito where user existence related errors are not prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will
default to ENABLED for newly created user pool clients if no value is
provided.
$sel:accessTokenValidity:UserPoolClientType', userPoolClientType_accessTokenValidity - The time limit, specified by tokenValidityUnits, defaulting to hours,
after which the access token is no longer valid and cannot be used.
$sel:creationDate:UserPoolClientType', userPoolClientType_creationDate - The date the user pool client was created.
$sel:readAttributes:UserPoolClientType', userPoolClientType_readAttributes - The Read-only attributes.
$sel:allowedOAuthScopes:UserPoolClientType', userPoolClientType_allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and profile. Possible values provided by
Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
$sel:allowedOAuthFlows:UserPoolClientType', userPoolClientType_allowedOAuthFlows - The allowed OAuth flows.
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 implicit to specify that the client should get the access token
(and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should get the
access token (and, optionally, ID token, based on scopes) from the token
endpoint using a combination of client and client_secret.
$sel:analyticsConfiguration:UserPoolClientType', userPoolClientType_analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
$sel:clientName:UserPoolClientType', userPoolClientType_clientName - The client name from the user pool request of the client type.
$sel:callbackURLs:UserPoolClientType', userPoolClientType_callbackURLs - A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
UserPoolDescriptionType
data UserPoolDescriptionType Source #
A user pool description.
See: newUserPoolDescriptionType smart constructor.
Constructors
| UserPoolDescriptionType' (Maybe StatusType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe LambdaConfigType) |
Instances
newUserPoolDescriptionType :: UserPoolDescriptionType Source #
Create a value of UserPoolDescriptionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:UserPoolDescriptionType', userPoolDescriptionType_status - The user pool status in a user pool description.
$sel:lastModifiedDate:UserPoolDescriptionType', userPoolDescriptionType_lastModifiedDate - The date the user pool description was last modified.
$sel:name:UserPoolDescriptionType', userPoolDescriptionType_name - The name in a user pool description.
$sel:id:UserPoolDescriptionType', userPoolDescriptionType_id - The ID in a user pool description.
$sel:creationDate:UserPoolDescriptionType', userPoolDescriptionType_creationDate - The date the user pool description was created.
$sel:lambdaConfig:UserPoolDescriptionType', userPoolDescriptionType_lambdaConfig - The Lambda configuration information in a user pool description.
UserPoolPolicyType
data UserPoolPolicyType Source #
The policy associated with a user pool.
See: newUserPoolPolicyType smart constructor.
Constructors
| UserPoolPolicyType' (Maybe PasswordPolicyType) |
Instances
newUserPoolPolicyType :: UserPoolPolicyType Source #
Create a value of UserPoolPolicyType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:passwordPolicy:UserPoolPolicyType', userPoolPolicyType_passwordPolicy - The password policy.
UserPoolType
data UserPoolType Source #
A container for information about the user pool.
See: newUserPoolType smart constructor.
Constructors
Instances
newUserPoolType :: UserPoolType Source #
Create a value of UserPoolType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:UserPoolType', userPoolType_status - The status of a user pool.
$sel:userPoolTags:UserPoolType', userPoolType_userPoolTags - The tags that are assigned to the user pool. A tag is a label that you
can apply to user pools to categorize and manage them in different ways,
such as by purpose, owner, environment, or other criteria.
$sel:emailConfigurationFailure:UserPoolType', userPoolType_emailConfigurationFailure - The reason why the email configuration cannot send the messages to your
users.
$sel:lastModifiedDate:UserPoolType', userPoolType_lastModifiedDate - The date the user pool was last modified.
$sel:verificationMessageTemplate:UserPoolType', userPoolType_verificationMessageTemplate - The template for verification messages.
$sel:estimatedNumberOfUsers:UserPoolType', userPoolType_estimatedNumberOfUsers - A number estimating the size of the user pool.
$sel:arn:UserPoolType', userPoolType_arn - The Amazon Resource Name (ARN) for the user pool.
$sel:domain:UserPoolType', userPoolType_domain - Holds the domain prefix if the user pool has a domain associated with
it.
$sel:customDomain:UserPoolType', userPoolType_customDomain - A custom domain name that you provide to Amazon Cognito. This parameter
applies only if you use a custom domain to host the sign-up and sign-in
pages for your application. For example: auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
$sel:emailVerificationMessage:UserPoolType', userPoolType_emailVerificationMessage - The contents of the email verification message.
$sel:smsAuthenticationMessage:UserPoolType', userPoolType_smsAuthenticationMessage - The contents of the SMS authentication message.
$sel:userPoolAddOns:UserPoolType', userPoolType_userPoolAddOns - The user pool add-ons.
$sel:schemaAttributes:UserPoolType', userPoolType_schemaAttributes - A container with the schema attributes of a user pool.
$sel:emailVerificationSubject:UserPoolType', userPoolType_emailVerificationSubject - The subject of the email verification message.
$sel:usernameAttributes:UserPoolType', userPoolType_usernameAttributes - Specifies whether email addresses or phone numbers can be specified as
usernames when a user signs up.
$sel:aliasAttributes:UserPoolType', userPoolType_aliasAttributes - Specifies the attributes that are aliased in a user pool.
$sel:accountRecoverySetting:UserPoolType', userPoolType_accountRecoverySetting - Use this setting to define which verified available method a user can
use to recover their password when they call ForgotPassword. It allows
you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password
recovery mechanism if the user also has SMS MFA enabled. In the absence
of this setting, Cognito uses the legacy behavior to determine the
recovery method where SMS is preferred over email.
$sel:emailConfiguration:UserPoolType', userPoolType_emailConfiguration - The email configuration.
$sel:smsVerificationMessage:UserPoolType', userPoolType_smsVerificationMessage - The contents of the SMS verification message.
$sel:name:UserPoolType', userPoolType_name - The name of the user pool.
$sel:mfaConfiguration:UserPoolType', userPoolType_mfaConfiguration - 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.
$sel:id:UserPoolType', userPoolType_id - The ID of the user pool.
$sel:smsConfigurationFailure:UserPoolType', userPoolType_smsConfigurationFailure - The reason why the SMS configuration cannot send the messages to your
users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
- InvalidSmsRoleAccessPolicyException - The IAM role which Cognito uses to send SMS messages is not properly configured. For more information, see SmsConfigurationType.
- SNSSandbox - The account is in SNS Sandbox and messages won’t reach unverified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your account out of the sandbox, see Moving out of the SMS sandbox.
$sel:creationDate:UserPoolType', userPoolType_creationDate - The date the user pool was created.
$sel:lambdaConfig:UserPoolType', userPoolType_lambdaConfig - The Lambda triggers associated with the user pool.
$sel:smsConfiguration:UserPoolType', userPoolType_smsConfiguration - The SMS configuration.
$sel:adminCreateUserConfig:UserPoolType', userPoolType_adminCreateUserConfig - The configuration for AdminCreateUser requests.
$sel:deviceConfiguration:UserPoolType', userPoolType_deviceConfiguration - The device configuration.
$sel:autoVerifiedAttributes:UserPoolType', userPoolType_autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.
$sel:policies:UserPoolType', userPoolType_policies - The policies associated with the user pool.
$sel:usernameConfiguration:UserPoolType', userPoolType_usernameConfiguration - You can choose to enable case sensitivity on the username input for the
selected sign-in option. For example, when this is set to False, users
will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information,
see
UsernameConfigurationType.
UserType
The user type.
See: newUserType smart constructor.
Constructors
| UserType' (Maybe Bool) (Maybe UserStatusType) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe [AttributeType]) (Maybe [MFAOptionType]) (Maybe POSIX) |
Instances
newUserType :: UserType Source #
Create a value of UserType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:UserType', userType_enabled - Specifies whether the user is enabled.
$sel:userStatus:UserType', userType_userStatus - 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.
- RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
- FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
$sel:username:UserType', userType_username - The user name of the user you wish to describe.
$sel:userCreateDate:UserType', userType_userCreateDate - The creation date of the user.
$sel:attributes:UserType', userType_attributes - A container with information about the user type attributes.
$sel:mfaOptions:UserType', userType_mfaOptions - The MFA options for the user.
$sel:userLastModifiedDate:UserType', userType_userLastModifiedDate - The last modified date of the user.
UsernameConfigurationType
data UsernameConfigurationType Source #
The username configuration type.
See: newUsernameConfigurationType smart constructor.
Constructors
| UsernameConfigurationType' Bool |
Instances
newUsernameConfigurationType Source #
Create a value of UsernameConfigurationType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:caseSensitive:UsernameConfigurationType', usernameConfigurationType_caseSensitive - Specifies whether username case sensitivity will be applied for all
users in the user pool through Cognito APIs.
Valid values include:
True: Enables case sensitivity for all username input. When this option is set toTrue, users must sign in using the exact capitalization of their given username. For example, “UserName”. This is the default value.False: Enables case insensitivity for all username input. For example, when this option is set toFalse, users will be able to sign in using either "username" or "Username". This option also enables bothpreferred_usernameandemailalias to be case insensitive, in addition to theusernameattribute.
VerificationMessageTemplateType
data VerificationMessageTemplateType Source #
The template for verification messages.
See: newVerificationMessageTemplateType smart constructor.
Constructors
| VerificationMessageTemplateType' (Maybe DefaultEmailOptionType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newVerificationMessageTemplateType :: VerificationMessageTemplateType Source #
Create a value of VerificationMessageTemplateType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultEmailOption:VerificationMessageTemplateType', verificationMessageTemplateType_defaultEmailOption - The default email option.
$sel:emailSubject:VerificationMessageTemplateType', verificationMessageTemplateType_emailSubject - The subject line for the email message template. EmailSubject is allowed
only if
EmailSendingAccount
is DEVELOPER.
$sel:emailSubjectByLink:VerificationMessageTemplateType', verificationMessageTemplateType_emailSubjectByLink - The subject line for the email message template for sending a
confirmation link to the user. EmailSubjectByLink is allowed only
EmailSendingAccount
is DEVELOPER.
$sel:smsMessage:VerificationMessageTemplateType', verificationMessageTemplateType_smsMessage - The SMS message template.
$sel:emailMessageByLink:VerificationMessageTemplateType', verificationMessageTemplateType_emailMessageByLink - The email message template for sending a confirmation link to the user.
EmailMessageByLink is allowed only if
EmailSendingAccount
is DEVELOPER.
$sel:emailMessage:VerificationMessageTemplateType', verificationMessageTemplateType_emailMessage - The email message template. EmailMessage is allowed only if
EmailSendingAccount
is DEVELOPER.