You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentityProvider::Types::AdminResetUserPasswordRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminResetUserPasswordRequest
- Defined in:
- (unknown)
Overview
When passing AdminResetUserPasswordRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
user_pool_id: "UserPoolIdType", # required
username: "UsernameType", # required
client_metadata: {
"StringType" => "StringType",
},
}
Represents the request to reset a user's password as an administrator.
Instance Attribute Summary collapse
-
#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.
-
#user_pool_id ⇒ String
The user pool ID for the user pool where you want to reset the user\'s password.
-
#username ⇒ String
The user name of the user whose password you wish to reset.
Instance Attribute Details
#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 AWS 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 AWS 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.
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS 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.
#user_pool_id ⇒ String
The user pool ID for the user pool where you want to reset the user\'s password.
#username ⇒ String
The user name of the user whose password you wish to reset.