Class: Aws::CognitoIdentityProvider::Types::ResendConfirmationCodeRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::ResendConfirmationCodeRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Represents the request to resend the confirmation code.
Constant Summary collapse
- SENSITIVE =
[:client_id, :secret_hash, :user_context_data, :username]
Instance Attribute Summary collapse
-
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your metrics for
ResendConfirmationCode
calls. -
#client_id ⇒ String
The ID of the client associated with the user pool.
-
#client_metadata ⇒ Hash<String,String>
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
-
#secret_hash ⇒ String
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.
-
#user_context_data ⇒ Types::UserContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location.
-
#username ⇒ String
The username of the user that you want to query or modify.
Instance Attribute Details
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your
metrics for ResendConfirmationCode
calls.
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6992 class ResendConfirmationCodeRequest < Struct.new( :client_id, :secret_hash, :user_context_data, :username, :analytics_metadata, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username] include Aws::Structure end |
#client_id ⇒ String
The ID of the client associated with the user pool.
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6992 class ResendConfirmationCodeRequest < Struct.new( :client_id, :secret_hash, :user_context_data, :username, :analytics_metadata, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username] include Aws::Structure end |
#client_metadata ⇒ Hash<String,String>
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.
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.
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6992 class ResendConfirmationCodeRequest < Struct.new( :client_id, :secret_hash, :user_context_data, :username, :analytics_metadata, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username] include Aws::Structure end |
#secret_hash ⇒ String
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.
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6992 class ResendConfirmationCodeRequest < Struct.new( :client_id, :secret_hash, :user_context_data, :username, :analytics_metadata, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username] include Aws::Structure end |
#user_context_data ⇒ Types::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.
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6992 class ResendConfirmationCodeRequest < Struct.new( :client_id, :secret_hash, :user_context_data, :username, :analytics_metadata, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username] include Aws::Structure end |
#username ⇒ String
The username of the user that you want to query or modify. The value
of this parameter is typically your user's username, but it can be
any of their alias attributes. If username
isn't an alias
attribute in your user pool, this value must be the sub
of a local
user or the username of a user from a third-party IdP.
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6992 class ResendConfirmationCodeRequest < Struct.new( :client_id, :secret_hash, :user_context_data, :username, :analytics_metadata, :client_metadata) SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username] include Aws::Structure end |