Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.ResendConfirmationCode

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html sandbox mode> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Synopsis

Creating a Request

data ResendConfirmationCode Source #

Represents the request to resend the confirmation code.

See: newResendConfirmationCode smart constructor.

Constructors

ResendConfirmationCode'

Fields

analyticsMetadata :: Maybe AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.
clientMetadata :: Maybe (HashMap Text Text)
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- 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 doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
secretHash :: Maybe (Sensitive Text)
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.
userContextData :: Maybe UserContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
clientId :: Sensitive Text
The ID of the client associated with the user pool.
username :: Sensitive Text
The username attribute of the user to whom you want to resend a confirmation code.

Instances

Instances details

ToJSON ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods toJSON :: ResendConfirmationCode -> Value # toEncoding :: ResendConfirmationCode -> Encoding # toJSONList :: [ResendConfirmationCode] -> Value # toEncodingList :: [ResendConfirmationCode] -> Encoding #
ToHeaders ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods toHeaders :: ResendConfirmationCode -> [Header] #
ToPath ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods toPath :: ResendConfirmationCode -> ByteString #
ToQuery ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods toQuery :: ResendConfirmationCode -> QueryString #
AWSRequest ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Associated Types type AWSResponse ResendConfirmationCode # Methods request :: (Service -> Service) -> ResendConfirmationCode -> Request ResendConfirmationCode # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ResendConfirmationCode -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ResendConfirmationCode))) #
Generic ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Associated Types type Rep ResendConfirmationCode :: Type -> Type # Methods from :: ResendConfirmationCode -> Rep ResendConfirmationCode x # to :: Rep ResendConfirmationCode x -> ResendConfirmationCode #
Show ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods showsPrec :: Int -> ResendConfirmationCode -> ShowS # show :: ResendConfirmationCode -> String # showList :: [ResendConfirmationCode] -> ShowS #
NFData ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods rnf :: ResendConfirmationCode -> () #
Eq ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods (==) :: ResendConfirmationCode -> ResendConfirmationCode -> Bool # (/=) :: ResendConfirmationCode -> ResendConfirmationCode -> Bool #
Hashable ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods hashWithSalt :: Int -> ResendConfirmationCode -> Int # hash :: ResendConfirmationCode -> Int #
type AWSResponse ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode type AWSResponse ResendConfirmationCode = ResendConfirmationCodeResponse
type Rep ResendConfirmationCode Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode type Rep ResendConfirmationCode = D1 ('MetaData "ResendConfirmationCode" "Amazonka.CognitoIdentityProvider.ResendConfirmationCode" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ResendConfirmationCode'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analyticsMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsMetadataType)) :: (S1 ('MetaSel ('Just "clientMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "secretHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "userContextData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContextDataType)) :: (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newResendConfirmationCode Source #

Arguments

:: Text	`ResendConfirmationCode`
-> Text	`ResendConfirmationCode`
-> 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:analyticsMetadata:ResendConfirmationCode', resendConfirmationCode_analyticsMetadata - The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.

$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.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

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 doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

$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:userContextData:ResendConfirmationCode', resendConfirmationCode_userContextData - Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

ResendConfirmationCode, resendConfirmationCode_clientId - The ID of the client associated with the user pool.

ResendConfirmationCode, resendConfirmationCode_username - The username attribute of the user to whom you want to resend a confirmation code.

Request Lenses

resendConfirmationCode_analyticsMetadata :: Lens' ResendConfirmationCode (Maybe AnalyticsMetadataType) Source #

The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.

resendConfirmationCode_clientMetadata :: Lens' ResendConfirmationCode (Maybe (HashMap Text Text)) Source #

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.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

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 doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

resendConfirmationCode_secretHash :: Lens' ResendConfirmationCode (Maybe Text) Source #

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.

resendConfirmationCode_userContextData :: Lens' ResendConfirmationCode (Maybe UserContextDataType) Source #

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

resendConfirmationCode_clientId :: Lens' ResendConfirmationCode Text Source #

The ID of the client associated with the user pool.

resendConfirmationCode_username :: Lens' ResendConfirmationCode Text Source #

The username attribute of the user to whom you want to resend a confirmation code.

Destructuring the Response

data ResendConfirmationCodeResponse Source #

The response from the server when Amazon Cognito makes the request to resend a confirmation code.

See: newResendConfirmationCodeResponse smart constructor.

Constructors

ResendConfirmationCodeResponse'
Fields codeDeliveryDetails :: Maybe CodeDeliveryDetailsType The code delivery details returned by the server in response to the request to resend the confirmation code. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ResendConfirmationCodeResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Associated Types type Rep ResendConfirmationCodeResponse :: Type -> Type # Methods from :: ResendConfirmationCodeResponse -> Rep ResendConfirmationCodeResponse x # to :: Rep ResendConfirmationCodeResponse x -> ResendConfirmationCodeResponse #
Read ResendConfirmationCodeResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods readsPrec :: Int -> ReadS ResendConfirmationCodeResponse # readList :: ReadS [ResendConfirmationCodeResponse] # readPrec :: ReadPrec ResendConfirmationCodeResponse # readListPrec :: ReadPrec [ResendConfirmationCodeResponse] #
Show ResendConfirmationCodeResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods showsPrec :: Int -> ResendConfirmationCodeResponse -> ShowS # show :: ResendConfirmationCodeResponse -> String # showList :: [ResendConfirmationCodeResponse] -> ShowS #
NFData ResendConfirmationCodeResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods rnf :: ResendConfirmationCodeResponse -> () #
Eq ResendConfirmationCodeResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode Methods (==) :: ResendConfirmationCodeResponse -> ResendConfirmationCodeResponse -> Bool # (/=) :: ResendConfirmationCodeResponse -> ResendConfirmationCodeResponse -> Bool #
type Rep ResendConfirmationCodeResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ResendConfirmationCode type Rep ResendConfirmationCodeResponse = D1 ('MetaData "ResendConfirmationCodeResponse" "Amazonka.CognitoIdentityProvider.ResendConfirmationCode" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ResendConfirmationCodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeDeliveryDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeDeliveryDetailsType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newResendConfirmationCodeResponse Source #

Arguments

:: Int	`$sel:httpStatus:ResendConfirmationCodeResponse'`
-> ResendConfirmationCodeResponse

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.

Response Lenses

resendConfirmationCodeResponse_codeDeliveryDetails :: Lens' ResendConfirmationCodeResponse (Maybe CodeDeliveryDetailsType) Source #

The code delivery details returned by the server in response to the request to resend the confirmation code.

resendConfirmationCodeResponse_httpStatus :: Lens' ResendConfirmationCodeResponse Int Source #

The response's http status code.