Network.AWS.CognitoIdentityProvider.UpdateUserPool

Updates the specified user pool with the specified attributes.

Creating a Request

updateUserPool

Arguments

:: Text

uupUserPoolId

-> UpdateUserPool

Creates a value of UpdateUserPool with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uupUserPoolTags - The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
• uupVerificationMessageTemplate - The template for verification messages.
• uupEmailVerificationMessage - The contents of the email verification message.
• uupSmsAuthenticationMessage - The contents of the SMS authentication message.
• uupUserPoolAddOns - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value AUDIT.
• uupEmailVerificationSubject - The subject of the email verification message.
• uupEmailConfiguration - Email configuration.
• uupSmsVerificationMessage - A container with information about the SMS verification message.
• uupMFAConfiguration - 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.
• uupLambdaConfig - The AWS Lambda configuration information from the request to update the user pool.
• uupSmsConfiguration - SMS configuration.
• uupAdminCreateUserConfig - The configuration for AdminCreateUser requests.
• uupDeviceConfiguration - Device configuration.
• uupAutoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
• uupPolicies - A container with the policies you wish to update in a user pool.
• uupUserPoolId - The user pool ID for the user pool you want to update.

data UpdateUserPool

Represents the request to update the user pool.

See: updateUserPool smart constructor.

Instances

Eq UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

(==) :: UpdateUserPool -> UpdateUserPool -> Bool

(/=) :: UpdateUserPool -> UpdateUserPool -> Bool

Data UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateUserPool -> c UpdateUserPool

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateUserPool

toConstr :: UpdateUserPool -> Constr

dataTypeOf :: UpdateUserPool -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateUserPool)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateUserPool)

gmapT :: (forall b. Data b => b -> b) -> UpdateUserPool -> UpdateUserPool

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPool -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPool -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateUserPool -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateUserPool -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateUserPool -> m UpdateUserPool

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPool -> m UpdateUserPool

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPool -> m UpdateUserPool

Read UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

readsPrec :: Int -> ReadS UpdateUserPool

readList :: ReadS [UpdateUserPool]

readPrec :: ReadPrec UpdateUserPool

readListPrec :: ReadPrec [UpdateUserPool]

Show UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

showsPrec :: Int -> UpdateUserPool -> ShowS

show :: UpdateUserPool -> String

showList :: [UpdateUserPool] -> ShowS

Generic UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Associated Types

type Rep UpdateUserPool :: Type -> Type

Methods

from :: UpdateUserPool -> Rep UpdateUserPool x

to :: Rep UpdateUserPool x -> UpdateUserPool

Hashable UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

hashWithSalt :: Int -> UpdateUserPool -> Int

hash :: UpdateUserPool -> Int

ToJSON UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

toJSON :: UpdateUserPool -> Value

toEncoding :: UpdateUserPool -> Encoding

toJSONList :: [UpdateUserPool] -> Value

toEncodingList :: [UpdateUserPool] -> Encoding

AWSRequest UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Associated Types

type Rs UpdateUserPool :: Type

Methods

request :: UpdateUserPool -> Request UpdateUserPool

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateUserPool -> ClientResponse -> m (Response UpdateUserPool)

ToHeaders UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

toHeaders :: UpdateUserPool -> [Header]

ToPath UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

toPath :: UpdateUserPool -> ByteString

ToQuery UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

toQuery :: UpdateUserPool -> QueryString

NFData UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

rnf :: UpdateUserPool -> ()

type Rep UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

type Rep UpdateUserPool = D1 (MetaData "UpdateUserPool" "Network.AWS.CognitoIdentityProvider.UpdateUserPool" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "UpdateUserPool'" PrefixI True) ((((S1 (MetaSel (Just "_uupUserPoolTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_uupVerificationMessageTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VerificationMessageTemplateType))) :*: (S1 (MetaSel (Just "_uupEmailVerificationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uupSmsAuthenticationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_uupUserPoolAddOns") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserPoolAddOnsType)) :*: S1 (MetaSel (Just "_uupEmailVerificationSubject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_uupEmailConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EmailConfigurationType)) :*: S1 (MetaSel (Just "_uupSmsVerificationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_uupMFAConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserPoolMFAType)) :*: S1 (MetaSel (Just "_uupLambdaConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LambdaConfigType))) :*: (S1 (MetaSel (Just "_uupSmsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SmsConfigurationType)) :*: S1 (MetaSel (Just "_uupAdminCreateUserConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdminCreateUserConfigType)))) :*: ((S1 (MetaSel (Just "_uupDeviceConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeviceConfigurationType)) :*: S1 (MetaSel (Just "_uupAutoVerifiedAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [VerifiedAttributeType]))) :*: (S1 (MetaSel (Just "_uupPolicies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserPoolPolicyType)) :*: S1 (MetaSel (Just "_uupUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs UpdateUserPool

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

type Rs UpdateUserPool = UpdateUserPoolResponse

Request Lenses

uupUserPoolTags :: Lens' UpdateUserPool (HashMap Text Text)

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

uupVerificationMessageTemplate :: Lens' UpdateUserPool (Maybe VerificationMessageTemplateType)

The template for verification messages.

uupEmailVerificationMessage :: Lens' UpdateUserPool (Maybe Text)

The contents of the email verification message.

uupSmsAuthenticationMessage :: Lens' UpdateUserPool (Maybe Text)

The contents of the SMS authentication message.

uupUserPoolAddOns :: Lens' UpdateUserPool (Maybe UserPoolAddOnsType)

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value AUDIT.

uupEmailVerificationSubject :: Lens' UpdateUserPool (Maybe Text)

The subject of the email verification message.

uupEmailConfiguration :: Lens' UpdateUserPool (Maybe EmailConfigurationType)

Email configuration.

uupSmsVerificationMessage :: Lens' UpdateUserPool (Maybe Text)

A container with information about the SMS verification message.

uupMFAConfiguration :: Lens' UpdateUserPool (Maybe UserPoolMFAType)

Can be one of the following values: * OFF - MFA tokens are not required and cannot be specified during user registration. * ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. * OPTIONAL - Users have the option when registering to create an MFA token.

uupLambdaConfig :: Lens' UpdateUserPool (Maybe LambdaConfigType)

The AWS Lambda configuration information from the request to update the user pool.

uupSmsConfiguration :: Lens' UpdateUserPool (Maybe SmsConfigurationType)

SMS configuration.

uupAdminCreateUserConfig :: Lens' UpdateUserPool (Maybe AdminCreateUserConfigType)

The configuration for AdminCreateUser requests.

uupDeviceConfiguration :: Lens' UpdateUserPool (Maybe DeviceConfigurationType)

Device configuration.

uupAutoVerifiedAttributes :: Lens' UpdateUserPool [VerifiedAttributeType]

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

uupPolicies :: Lens' UpdateUserPool (Maybe UserPoolPolicyType)

A container with the policies you wish to update in a user pool.

uupUserPoolId :: Lens' UpdateUserPool Text

The user pool ID for the user pool you want to update.

Destructuring the Response

updateUserPoolResponse

Arguments

:: Int

uuprsResponseStatus

-> UpdateUserPoolResponse

Creates a value of UpdateUserPoolResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uuprsResponseStatus - -- | The response status code.

data UpdateUserPoolResponse

Represents the response from the server when you make a request to update the user pool.

See: updateUserPoolResponse smart constructor.

Instances

Eq UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

(==) :: UpdateUserPoolResponse -> UpdateUserPoolResponse -> Bool

(/=) :: UpdateUserPoolResponse -> UpdateUserPoolResponse -> Bool

Data UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateUserPoolResponse -> c UpdateUserPoolResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateUserPoolResponse

toConstr :: UpdateUserPoolResponse -> Constr

dataTypeOf :: UpdateUserPoolResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateUserPoolResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateUserPoolResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateUserPoolResponse -> UpdateUserPoolResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPoolResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPoolResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateUserPoolResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateUserPoolResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateUserPoolResponse -> m UpdateUserPoolResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPoolResponse -> m UpdateUserPoolResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPoolResponse -> m UpdateUserPoolResponse

Read UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

readsPrec :: Int -> ReadS UpdateUserPoolResponse

readList :: ReadS [UpdateUserPoolResponse]

readPrec :: ReadPrec UpdateUserPoolResponse

readListPrec :: ReadPrec [UpdateUserPoolResponse]

Show UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

showsPrec :: Int -> UpdateUserPoolResponse -> ShowS

show :: UpdateUserPoolResponse -> String

showList :: [UpdateUserPoolResponse] -> ShowS

Generic UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Associated Types

type Rep UpdateUserPoolResponse :: Type -> Type

Methods

from :: UpdateUserPoolResponse -> Rep UpdateUserPoolResponse x

to :: Rep UpdateUserPoolResponse x -> UpdateUserPoolResponse

NFData UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

Methods

rnf :: UpdateUserPoolResponse -> ()

type Rep UpdateUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPool

type Rep UpdateUserPoolResponse = D1 (MetaData "UpdateUserPoolResponse" "Network.AWS.CognitoIdentityProvider.UpdateUserPool" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" True) (C1 (MetaCons "UpdateUserPoolResponse'" PrefixI True) (S1 (MetaSel (Just "_uuprsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

uuprsResponseStatus :: Lens' UpdateUserPoolResponse Int

• - | The response status code.