Class: Aws::CognitoIdentityProvider::Types::AdminConfirmSignUpRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminConfirmSignUpRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Confirm a user's registration as a user pool administrator.
Constant Summary collapse
- SENSITIVE =
[:username]
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 ID of the user pool where you want to confirm a user's sign-up request.
-
#username ⇒ String
The username of the user that you want to query or modify.
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.
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.
ClientMetadata
parameter, note 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, theClientMetadata
parameter serves no purpose.Validate the
ClientMetadata
value.Encrypt the
ClientMetadata
value. Don't send sensitive information in this parameter.
305 306 307 308 309 310 311 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 305 class AdminConfirmSignUpRequest < Struct.new( :user_pool_id, :username, :client_metadata) SENSITIVE = [:username] include Aws::Structure end |
#user_pool_id ⇒ String
The ID of the user pool where you want to confirm a user's sign-up request.
305 306 307 308 309 310 311 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 305 class AdminConfirmSignUpRequest < Struct.new( :user_pool_id, :username, :client_metadata) SENSITIVE = [: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.
305 306 307 308 309 310 311 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 305 class AdminConfirmSignUpRequest < Struct.new( :user_pool_id, :username, :client_metadata) SENSITIVE = [:username] include Aws::Structure end |