NAME
Paws::CognitoIdp - Perl Interface to AWS Amazon Cognito Identity Provider
SYNOPSIS
use Paws;
my $obj = Paws->service('CognitoIdp');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
You can create a user pool in Amazon Cognito Identity to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito Identity, which is a new capability that is available as a beta.
METHODS
AddCustomAttributes(CustomAttributes => ArrayRef[Paws::CognitoIdp::SchemaAttributeType], UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AddCustomAttributes
Returns: a Paws::CognitoIdp::AddCustomAttributesResponse instance
Adds additional user attributes to the user pool schema.AdminConfirmSignUp(Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminConfirmSignUp
Returns: a Paws::CognitoIdp::AdminConfirmSignUpResponse instance
Confirms user registration as an admin without using a confirmation
code. Works on any user.AdminDeleteUser(Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminDeleteUser
Returns: nothing
Deletes a user as an administrator. Works on any user.AdminDeleteUserAttributes(UserAttributeNames => ArrayRef[Str], Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminDeleteUserAttributes
Returns: a Paws::CognitoIdp::AdminDeleteUserAttributesResponse instance
Deletes the user attributes in a user pool as an administrator. Works
on any user.AdminDisableUser(Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminDisableUser
Returns: a Paws::CognitoIdp::AdminDisableUserResponse instance
Disables the specified user as an administrator. Works on any user.AdminEnableUser(Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminEnableUser
Returns: a Paws::CognitoIdp::AdminEnableUserResponse instance
Enables the specified user as an administrator. Works on any user.AdminGetUser(Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminGetUser
Returns: a Paws::CognitoIdp::AdminGetUserResponse instance
Gets the specified user by user name in a user pool as an
administrator. Works on any user.AdminResetUserPassword(Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminResetUserPassword
Returns: a Paws::CognitoIdp::AdminResetUserPasswordResponse instance
Resets the specified user's password in a user pool as an
administrator. Works on any user.AdminSetUserSettings(MFAOptions => ArrayRef[Paws::CognitoIdp::MFAOptionType], Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminSetUserSettings
Returns: a Paws::CognitoIdp::AdminSetUserSettingsResponse instance
Sets all the user settings for a specified user name. Works on any
user.AdminUpdateUserAttributes(UserAttributes => ArrayRef[Paws::CognitoIdp::AttributeType], Username => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::AdminUpdateUserAttributes
Returns: a Paws::CognitoIdp::AdminUpdateUserAttributesResponse instance
Updates the specified user's attributes, including developer
attributes, as an administrator. Works on any user.ChangePassword(PreviousPassword => Str, ProposedPassword => Str, [AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::ChangePassword
Returns: a Paws::CognitoIdp::ChangePasswordResponse instance
Changes the password for a specified user in a user pool.ConfirmForgotPassword(ClientId => Str, ConfirmationCode => Str, Password => Str, Username => Str, [SecretHash => Str])
Each argument is described in detail in: Paws::CognitoIdp::ConfirmForgotPassword
Returns: a Paws::CognitoIdp::ConfirmForgotPasswordResponse instance
Allows a user to enter a code provided when they reset their password
to update their password.ConfirmSignUp(ClientId => Str, ConfirmationCode => Str, Username => Str, [ForceAliasCreation => Bool, SecretHash => Str])
Each argument is described in detail in: Paws::CognitoIdp::ConfirmSignUp
Returns: a Paws::CognitoIdp::ConfirmSignUpResponse instance
Confirms registration of a user and handles the existing alias from a
previous user.CreateUserPool(PoolName => Str, [AliasAttributes => ArrayRef[Str], AutoVerifiedAttributes => ArrayRef[Str], EmailVerificationMessage => Str, EmailVerificationSubject => Str, LambdaConfig => Paws::CognitoIdp::LambdaConfigType, MfaConfiguration => Str, Policies => Paws::CognitoIdp::UserPoolPolicyType, SmsAuthenticationMessage => Str, SmsVerificationMessage => Str])
Each argument is described in detail in: Paws::CognitoIdp::CreateUserPool
Returns: a Paws::CognitoIdp::CreateUserPoolResponse instance
Creates a new Amazon Cognito user pool and sets the password policy for
the pool.CreateUserPoolClient(ClientName => Str, UserPoolId => Str, [GenerateSecret => Bool])
Each argument is described in detail in: Paws::CognitoIdp::CreateUserPoolClient
Returns: a Paws::CognitoIdp::CreateUserPoolClientResponse instance
Creates the user pool client.DeleteUser([AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::DeleteUser
Returns: nothing
Allows a user to delete one's self.DeleteUserAttributes(UserAttributeNames => ArrayRef[Str], [AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::DeleteUserAttributes
Returns: a Paws::CognitoIdp::DeleteUserAttributesResponse instance
Deletes the attributes for a user.DeleteUserPool(UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::DeleteUserPool
Returns: nothing
Deletes the specified Amazon Cognito user pool.DeleteUserPoolClient(ClientId => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::DeleteUserPoolClient
Returns: nothing
Allows the developer to delete the user pool client.DescribeUserPool(UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::DescribeUserPool
Returns: a Paws::CognitoIdp::DescribeUserPoolResponse instance
Returns the configuration information and metadata of the specified
user pool.DescribeUserPoolClient(ClientId => Str, UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::DescribeUserPoolClient
Returns: a Paws::CognitoIdp::DescribeUserPoolClientResponse instance
Client method for returning the configuration information and metadata
of the specified user pool client.ForgotPassword(ClientId => Str, Username => Str, [SecretHash => Str])
Each argument is described in detail in: Paws::CognitoIdp::ForgotPassword
Returns: a Paws::CognitoIdp::ForgotPasswordResponse instance
Retrieves the password for the specified client ID or username.GetJWKS(UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::GetJWKS
Returns: a Paws::CognitoIdp::GetJWKSResponse instance
Gets the JSON Web keys for the specified user pool.GetOpenIdConfiguration(UserPoolId => Str)
Each argument is described in detail in: Paws::CognitoIdp::GetOpenIdConfiguration
Returns: a Paws::CognitoIdp::GetOpenIdConfigurationResponse instance
Gets the OpenId configuration information for the specified user pool.GetUser([AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::GetUser
Returns: a Paws::CognitoIdp::GetUserResponse instance
Gets the user attributes and metadata for a user.GetUserAttributeVerificationCode(AttributeName => Str, [AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::GetUserAttributeVerificationCode
Returns: a Paws::CognitoIdp::GetUserAttributeVerificationCodeResponse instance
Gets the user attribute verification code for the specified attribute
name.ListUserPoolClients(UserPoolId => Str, [MaxResults => Int, NextToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::ListUserPoolClients
Returns: a Paws::CognitoIdp::ListUserPoolClientsResponse instance
Lists the clients that have been created for the specified user pool.ListUserPools(MaxResults => Int, [NextToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::ListUserPools
Returns: a Paws::CognitoIdp::ListUserPoolsResponse instance
Lists the user pools associated with an AWS account.ListUsers(UserPoolId => Str, [AttributesToGet => ArrayRef[Str], Limit => Int, PaginationToken => Str, UserStatus => Str])
Each argument is described in detail in: Paws::CognitoIdp::ListUsers
Returns: a Paws::CognitoIdp::ListUsersResponse instance
Lists the users in the Amazon Cognito user pool.ResendConfirmationCode(ClientId => Str, Username => Str, [SecretHash => Str])
Each argument is described in detail in: Paws::CognitoIdp::ResendConfirmationCode
Returns: a Paws::CognitoIdp::ResendConfirmationCodeResponse instance
Resends the confirmation (for confirmation of registration) to a
specific user in the user pool.SetUserSettings(AccessToken => Str, MFAOptions => ArrayRef[Paws::CognitoIdp::MFAOptionType])
Each argument is described in detail in: Paws::CognitoIdp::SetUserSettings
Returns: a Paws::CognitoIdp::SetUserSettingsResponse instance
Sets the user settings like multi-factor authentication (MFA). If MFA
is to be removed for a particular attribute pass the attribute with
code delivery as null. If null list is passed, all MFA options are
removed.SignUp(ClientId => Str, Password => Str, Username => Str, [SecretHash => Str, UserAttributes => ArrayRef[Paws::CognitoIdp::AttributeType], ValidationData => ArrayRef[Paws::CognitoIdp::AttributeType]])
Each argument is described in detail in: Paws::CognitoIdp::SignUp
Returns: a Paws::CognitoIdp::SignUpResponse instance
Registers the user in the specified user pool and creates a user name,
password, and user attributes.UpdateUserAttributes(UserAttributes => ArrayRef[Paws::CognitoIdp::AttributeType], [AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::UpdateUserAttributes
Returns: a Paws::CognitoIdp::UpdateUserAttributesResponse instance
Allows a user to update a specific attribute (one at a time).UpdateUserPool(UserPoolId => Str, [AutoVerifiedAttributes => ArrayRef[Str], EmailVerificationMessage => Str, EmailVerificationSubject => Str, LambdaConfig => Paws::CognitoIdp::LambdaConfigType, MfaConfiguration => Str, Policies => Paws::CognitoIdp::UserPoolPolicyType, SmsAuthenticationMessage => Str, SmsVerificationMessage => Str])
Each argument is described in detail in: Paws::CognitoIdp::UpdateUserPool
Returns: a Paws::CognitoIdp::UpdateUserPoolResponse instance
Updates the specified user pool with the specified attributes.UpdateUserPoolClient(ClientId => Str, UserPoolId => Str, [ClientName => Str])
Each argument is described in detail in: Paws::CognitoIdp::UpdateUserPoolClient
Returns: a Paws::CognitoIdp::UpdateUserPoolClientResponse instance
Allows the developer to update the specified user pool client and
password policy.VerifyUserAttribute(AttributeName => Str, Code => Str, [AccessToken => Str])
Each argument is described in detail in: Paws::CognitoIdp::VerifyUserAttribute
Returns: a Paws::CognitoIdp::VerifyUserAttributeResponse instance
Verifies the specified user attributes in the user pool.SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues