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

Using the Amazon Cognito User Pools API, you can create a user pool 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 User Pools.

For more information, see the Amazon Cognito Documentation.

For the AWS API documentation, see https://docs.aws.amazon.com/cognito/

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.

AdminAddUserToGroup

GroupName => Str
Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminAddUserToGroup

Returns: nothing

Adds the specified user to the specified group.

Requires developer credentials.

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.

Requires developer credentials.

AdminCreateUser

Username => Str
UserPoolId => Str
[DesiredDeliveryMediums => ArrayRef[Str|Undef]]
[ForceAliasCreation => Bool]
[MessageAction => Str]
[TemporaryPassword => Str]
[UserAttributes => ArrayRef[Paws::CognitoIdp::AttributeType]]
[ValidationData => ArrayRef[Paws::CognitoIdp::AttributeType]]

Each argument is described in detail in: Paws::CognitoIdp::AdminCreateUser

Returns: a Paws::CognitoIdp::AdminCreateUserResponse instance

Creates a new user in the specified user pool.

If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).

This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

AdminCreateUser requires developer credentials.

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.

Requires developer credentials.

AdminDeleteUserAttributes

UserAttributeNames => ArrayRef[Str|Undef]
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.

Requires developer credentials.

AdminDisableProviderForUser

User => Paws::CognitoIdp::ProviderUserIdentifierType
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminDisableProviderForUser

Returns: a Paws::CognitoIdp::AdminDisableProviderForUserResponse instance

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

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.

Requires developer credentials.

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.

Requires developer credentials.

AdminForgetDevice

DeviceKey => Str
Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminForgetDevice

Returns: nothing

Forgets the device, as an administrator.

Requires developer credentials.

AdminGetDevice

DeviceKey => Str
Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminGetDevice

Returns: a Paws::CognitoIdp::AdminGetDeviceResponse instance

Gets the device, as an administrator.

Requires developer credentials.

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.

Requires developer credentials.

AdminInitiateAuth

AuthFlow => Str
ClientId => Str
UserPoolId => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[AuthParameters => Paws::CognitoIdp::AuthParametersType]
[ClientMetadata => Paws::CognitoIdp::ClientMetadataType]
[ContextData => Paws::CognitoIdp::ContextDataType]

Each argument is described in detail in: Paws::CognitoIdp::AdminInitiateAuth

Returns: a Paws::CognitoIdp::AdminInitiateAuthResponse instance

Initiates the authentication flow, as an administrator.

Requires developer credentials.

AdminLinkProviderForUser

DestinationUser => Paws::CognitoIdp::ProviderUserIdentifierType
SourceUser => Paws::CognitoIdp::ProviderUserIdentifierType
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminLinkProviderForUser

Returns: a Paws::CognitoIdp::AdminLinkProviderForUserResponse instance

Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.

See also .

This action is enabled only for admin access and requires developer credentials.

AdminListDevices

Username => Str
UserPoolId => Str
[Limit => Int]
[PaginationToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::AdminListDevices

Returns: a Paws::CognitoIdp::AdminListDevicesResponse instance

Lists devices, as an administrator.

Requires developer credentials.

AdminListGroupsForUser

Username => Str
UserPoolId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::AdminListGroupsForUser

Returns: a Paws::CognitoIdp::AdminListGroupsForUserResponse instance

Lists the groups that the user belongs to.

Requires developer credentials.

AdminListUserAuthEvents

Username => Str
UserPoolId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::AdminListUserAuthEvents

Returns: a Paws::CognitoIdp::AdminListUserAuthEventsResponse instance

Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.

AdminRemoveUserFromGroup

GroupName => Str
Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminRemoveUserFromGroup

Returns: nothing

Removes the specified user from the specified group.

Requires developer credentials.

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.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Requires developer credentials.

AdminRespondToAuthChallenge

ChallengeName => Str
ClientId => Str
UserPoolId => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[ChallengeResponses => Paws::CognitoIdp::ChallengeResponsesType]
[ContextData => Paws::CognitoIdp::ContextDataType]
[Session => Str]

Each argument is described in detail in: Paws::CognitoIdp::AdminRespondToAuthChallenge

Returns: a Paws::CognitoIdp::AdminRespondToAuthChallengeResponse instance

Responds to an authentication challenge, as an administrator.

Requires developer credentials.

AdminSetUserMFAPreference

Username => Str
UserPoolId => Str
[SMSMfaSettings => Paws::CognitoIdp::SMSMfaSettingsType]
[SoftwareTokenMfaSettings => Paws::CognitoIdp::SoftwareTokenMfaSettingsType]

Each argument is described in detail in: Paws::CognitoIdp::AdminSetUserMFAPreference

Returns: a Paws::CognitoIdp::AdminSetUserMFAPreferenceResponse instance

Sets the user's multi-factor authentication (MFA) preference.

AdminSetUserPassword

Password => Str
Username => Str
UserPoolId => Str
[Permanent => Bool]

Each argument is described in detail in: Paws::CognitoIdp::AdminSetUserPassword

Returns: a Paws::CognitoIdp::AdminSetUserPasswordResponse instance

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.

Requires developer credentials.

AdminUpdateAuthEventFeedback

EventId => Str
FeedbackValue => Str
Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminUpdateAuthEventFeedback

Returns: a Paws::CognitoIdp::AdminUpdateAuthEventFeedbackResponse instance

Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

AdminUpdateDeviceStatus

DeviceKey => Str
Username => Str
UserPoolId => Str
[DeviceRememberedStatus => Str]

Each argument is described in detail in: Paws::CognitoIdp::AdminUpdateDeviceStatus

Returns: a Paws::CognitoIdp::AdminUpdateDeviceStatusResponse instance

Updates the device status as an administrator.

Requires developer credentials.

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.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Requires developer credentials.

AdminUserGlobalSignOut

Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::AdminUserGlobalSignOut

Returns: a Paws::CognitoIdp::AdminUserGlobalSignOutResponse instance

Signs out users from all devices, as an administrator.

Requires developer credentials.

AssociateSoftwareToken

[AccessToken => Str]
[Session => Str]

Each argument is described in detail in: Paws::CognitoIdp::AssociateSoftwareToken

Returns: a Paws::CognitoIdp::AssociateSoftwareTokenResponse instance

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

ChangePassword

AccessToken => Str
PreviousPassword => Str
ProposedPassword => 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.

ConfirmDevice

AccessToken => Str
DeviceKey => Str
[DeviceName => Str]
[DeviceSecretVerifierConfig => Paws::CognitoIdp::DeviceSecretVerifierConfigType]

Each argument is described in detail in: Paws::CognitoIdp::ConfirmDevice

Returns: a Paws::CognitoIdp::ConfirmDeviceResponse instance

Confirms tracking of the device. This API call is the call that begins device tracking.

ConfirmForgotPassword

ClientId => Str
ConfirmationCode => Str
Password => Str
Username => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[SecretHash => Str]
[UserContextData => Paws::CognitoIdp::UserContextDataType]

Each argument is described in detail in: Paws::CognitoIdp::ConfirmForgotPassword

Returns: a Paws::CognitoIdp::ConfirmForgotPasswordResponse instance

Allows a user to enter a confirmation code to reset a forgotten password.

ConfirmSignUp

ClientId => Str
ConfirmationCode => Str
Username => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[ForceAliasCreation => Bool]
[SecretHash => Str]
[UserContextData => Paws::CognitoIdp::UserContextDataType]

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.

CreateGroup

GroupName => Str
UserPoolId => Str
[Description => Str]
[Precedence => Int]
[RoleArn => Str]

Each argument is described in detail in: Paws::CognitoIdp::CreateGroup

Returns: a Paws::CognitoIdp::CreateGroupResponse instance

Creates a new group in the specified user pool.

Requires developer credentials.

CreateIdentityProvider

ProviderDetails => Paws::CognitoIdp::ProviderDetailsType
ProviderName => Str
ProviderType => Str
UserPoolId => Str
[AttributeMapping => Paws::CognitoIdp::AttributeMappingType]
[IdpIdentifiers => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CognitoIdp::CreateIdentityProvider

Returns: a Paws::CognitoIdp::CreateIdentityProviderResponse instance

Creates an identity provider for a user pool.

CreateResourceServer

Identifier => Str
Name => Str
UserPoolId => Str
[Scopes => ArrayRef[Paws::CognitoIdp::ResourceServerScopeType]]

Each argument is described in detail in: Paws::CognitoIdp::CreateResourceServer

Returns: a Paws::CognitoIdp::CreateResourceServerResponse instance

Creates a new OAuth2.0 resource server and defines custom scopes in it.

CreateUserImportJob

CloudWatchLogsRoleArn => Str
JobName => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::CreateUserImportJob

Returns: a Paws::CognitoIdp::CreateUserImportJobResponse instance

Creates the user import job.

CreateUserPool

PoolName => Str
[AdminCreateUserConfig => Paws::CognitoIdp::AdminCreateUserConfigType]
[AliasAttributes => ArrayRef[Str|Undef]]
[AutoVerifiedAttributes => ArrayRef[Str|Undef]]
[DeviceConfiguration => Paws::CognitoIdp::DeviceConfigurationType]
[EmailConfiguration => Paws::CognitoIdp::EmailConfigurationType]
[EmailVerificationMessage => Str]
[EmailVerificationSubject => Str]
[LambdaConfig => Paws::CognitoIdp::LambdaConfigType]
[MfaConfiguration => Str]
[Policies => Paws::CognitoIdp::UserPoolPolicyType]
[Schema => ArrayRef[Paws::CognitoIdp::SchemaAttributeType]]
[SmsAuthenticationMessage => Str]
[SmsConfiguration => Paws::CognitoIdp::SmsConfigurationType]
[SmsVerificationMessage => Str]
[UsernameAttributes => ArrayRef[Str|Undef]]
[UserPoolAddOns => Paws::CognitoIdp::UserPoolAddOnsType]
[UserPoolTags => Paws::CognitoIdp::UserPoolTagsType]
[VerificationMessageTemplate => Paws::CognitoIdp::VerificationMessageTemplateType]

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
[AllowedOAuthFlows => ArrayRef[Str|Undef]]
[AllowedOAuthFlowsUserPoolClient => Bool]
[AllowedOAuthScopes => ArrayRef[Str|Undef]]
[AnalyticsConfiguration => Paws::CognitoIdp::AnalyticsConfigurationType]
[CallbackURLs => ArrayRef[Str|Undef]]
[DefaultRedirectURI => Str]
[ExplicitAuthFlows => ArrayRef[Str|Undef]]
[GenerateSecret => Bool]
[LogoutURLs => ArrayRef[Str|Undef]]
[ReadAttributes => ArrayRef[Str|Undef]]
[RefreshTokenValidity => Int]
[SupportedIdentityProviders => ArrayRef[Str|Undef]]
[WriteAttributes => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CognitoIdp::CreateUserPoolClient

Returns: a Paws::CognitoIdp::CreateUserPoolClientResponse instance

Creates the user pool client.

CreateUserPoolDomain

Domain => Str
UserPoolId => Str
[CustomDomainConfig => Paws::CognitoIdp::CustomDomainConfigType]

Each argument is described in detail in: Paws::CognitoIdp::CreateUserPoolDomain

Returns: a Paws::CognitoIdp::CreateUserPoolDomainResponse instance

Creates a new domain for a user pool.

DeleteGroup

GroupName => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DeleteGroup

Returns: nothing

Deletes a group. Currently only groups with no members can be deleted.

Requires developer credentials.

DeleteIdentityProvider

ProviderName => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DeleteIdentityProvider

Returns: nothing

Deletes an identity provider for a user pool.

DeleteResourceServer

Identifier => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DeleteResourceServer

Returns: nothing

Deletes a resource server.

DeleteUser

AccessToken => Str

Each argument is described in detail in: Paws::CognitoIdp::DeleteUser

Returns: nothing

Allows a user to delete himself or herself.

DeleteUserAttributes

AccessToken => Str
UserAttributeNames => ArrayRef[Str|Undef]

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.

DeleteUserPoolDomain

Domain => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DeleteUserPoolDomain

Returns: a Paws::CognitoIdp::DeleteUserPoolDomainResponse instance

Deletes a domain for a user pool.

DescribeIdentityProvider

ProviderName => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DescribeIdentityProvider

Returns: a Paws::CognitoIdp::DescribeIdentityProviderResponse instance

Gets information about a specific identity provider.

DescribeResourceServer

Identifier => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DescribeResourceServer

Returns: a Paws::CognitoIdp::DescribeResourceServerResponse instance

Describes a resource server.

DescribeRiskConfiguration

UserPoolId => Str
[ClientId => Str]

Each argument is described in detail in: Paws::CognitoIdp::DescribeRiskConfiguration

Returns: a Paws::CognitoIdp::DescribeRiskConfigurationResponse instance

Describes the risk configuration.

DescribeUserImportJob

JobId => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::DescribeUserImportJob

Returns: a Paws::CognitoIdp::DescribeUserImportJobResponse instance

Describes the user import job.

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 app client.

DescribeUserPoolDomain

Domain => Str

Each argument is described in detail in: Paws::CognitoIdp::DescribeUserPoolDomain

Returns: a Paws::CognitoIdp::DescribeUserPoolDomainResponse instance

Gets information about a domain.

ForgetDevice

DeviceKey => Str
[AccessToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ForgetDevice

Returns: nothing

Forgets the specified device.

ForgotPassword

ClientId => Str
Username => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[SecretHash => Str]
[UserContextData => Paws::CognitoIdp::UserContextDataType]

Each argument is described in detail in: Paws::CognitoIdp::ForgotPassword

Returns: a Paws::CognitoIdp::ForgotPasswordResponse instance

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

GetCSVHeader

UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::GetCSVHeader

Returns: a Paws::CognitoIdp::GetCSVHeaderResponse instance

Gets the header information for the .csv file to be used as input for the user import job.

GetDevice

DeviceKey => Str
[AccessToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::GetDevice

Returns: a Paws::CognitoIdp::GetDeviceResponse instance

Gets the device.

GetGroup

GroupName => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::GetGroup

Returns: a Paws::CognitoIdp::GetGroupResponse instance

Gets a group.

Requires developer credentials.

GetIdentityProviderByIdentifier

IdpIdentifier => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::GetIdentityProviderByIdentifier

Returns: a Paws::CognitoIdp::GetIdentityProviderByIdentifierResponse instance

Gets the specified identity provider.

GetSigningCertificate

UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::GetSigningCertificate

Returns: a Paws::CognitoIdp::GetSigningCertificateResponse instance

This method takes a user pool ID, and returns the signing certificate.

GetUICustomization

UserPoolId => Str
[ClientId => Str]

Each argument is described in detail in: Paws::CognitoIdp::GetUICustomization

Returns: a Paws::CognitoIdp::GetUICustomizationResponse instance

Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.

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

AccessToken => Str
AttributeName => 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.

GetUserPoolMfaConfig

UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::GetUserPoolMfaConfig

Returns: a Paws::CognitoIdp::GetUserPoolMfaConfigResponse instance

Gets the user pool multi-factor authentication (MFA) configuration.

GlobalSignOut

AccessToken => Str

Each argument is described in detail in: Paws::CognitoIdp::GlobalSignOut

Returns: a Paws::CognitoIdp::GlobalSignOutResponse instance

Signs out users from all devices.

InitiateAuth

AuthFlow => Str
ClientId => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[AuthParameters => Paws::CognitoIdp::AuthParametersType]
[ClientMetadata => Paws::CognitoIdp::ClientMetadataType]
[UserContextData => Paws::CognitoIdp::UserContextDataType]

Each argument is described in detail in: Paws::CognitoIdp::InitiateAuth

Returns: a Paws::CognitoIdp::InitiateAuthResponse instance

Initiates the authentication flow.

ListDevices

AccessToken => Str
[Limit => Int]
[PaginationToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ListDevices

Returns: a Paws::CognitoIdp::ListDevicesResponse instance

Lists the devices.

ListGroups

UserPoolId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ListGroups

Returns: a Paws::CognitoIdp::ListGroupsResponse instance

Lists the groups associated with a user pool.

Requires developer credentials.

ListIdentityProviders

UserPoolId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ListIdentityProviders

Returns: a Paws::CognitoIdp::ListIdentityProvidersResponse instance

Lists information about all identity providers for a user pool.

ListResourceServers

UserPoolId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ListResourceServers

Returns: a Paws::CognitoIdp::ListResourceServersResponse instance

Lists the resource servers for a user pool.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::CognitoIdp::ListTagsForResource

Returns: a Paws::CognitoIdp::ListTagsForResourceResponse instance

Lists the tags that are assigned to an Amazon Cognito user pool.

A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

ListUserImportJobs

MaxResults => Int
UserPoolId => Str
[PaginationToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ListUserImportJobs

Returns: a Paws::CognitoIdp::ListUserImportJobsResponse instance

Lists the user import jobs.

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|Undef]]
[Filter => Str]
[Limit => Int]
[PaginationToken => 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.

ListUsersInGroup

GroupName => Str
UserPoolId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CognitoIdp::ListUsersInGroup

Returns: a Paws::CognitoIdp::ListUsersInGroupResponse instance

Lists the users in the specified group.

Requires developer credentials.

ResendConfirmationCode

ClientId => Str
Username => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[SecretHash => Str]
[UserContextData => Paws::CognitoIdp::UserContextDataType]

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.

RespondToAuthChallenge

ChallengeName => Str
ClientId => Str
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[ChallengeResponses => Paws::CognitoIdp::ChallengeResponsesType]
[Session => Str]
[UserContextData => Paws::CognitoIdp::UserContextDataType]

Each argument is described in detail in: Paws::CognitoIdp::RespondToAuthChallenge

Returns: a Paws::CognitoIdp::RespondToAuthChallengeResponse instance

Responds to the authentication challenge.

SetRiskConfiguration

UserPoolId => Str
[AccountTakeoverRiskConfiguration => Paws::CognitoIdp::AccountTakeoverRiskConfigurationType]
[ClientId => Str]
[CompromisedCredentialsRiskConfiguration => Paws::CognitoIdp::CompromisedCredentialsRiskConfigurationType]
[RiskExceptionConfiguration => Paws::CognitoIdp::RiskExceptionConfigurationType]

Each argument is described in detail in: Paws::CognitoIdp::SetRiskConfiguration

Returns: a Paws::CognitoIdp::SetRiskConfigurationResponse instance

Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

See .

SetUICustomization

UserPoolId => Str
[ClientId => Str]
[CSS => Str]
[ImageFile => Str]

Each argument is described in detail in: Paws::CognitoIdp::SetUICustomization

Returns: a Paws::CognitoIdp::SetUICustomizationResponse instance

Sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

SetUserMFAPreference

AccessToken => Str
[SMSMfaSettings => Paws::CognitoIdp::SMSMfaSettingsType]
[SoftwareTokenMfaSettings => Paws::CognitoIdp::SoftwareTokenMfaSettingsType]

Each argument is described in detail in: Paws::CognitoIdp::SetUserMFAPreference

Returns: a Paws::CognitoIdp::SetUserMFAPreferenceResponse instance

Set the user's multi-factor authentication (MFA) method preference.

SetUserPoolMfaConfig

UserPoolId => Str
[MfaConfiguration => Str]
[SmsMfaConfiguration => Paws::CognitoIdp::SmsMfaConfigType]
[SoftwareTokenMfaConfiguration => Paws::CognitoIdp::SoftwareTokenMfaConfigType]

Each argument is described in detail in: Paws::CognitoIdp::SetUserPoolMfaConfig

Returns: a Paws::CognitoIdp::SetUserPoolMfaConfigResponse instance

Set the user pool MFA configuration.

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
[AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType]
[SecretHash => Str]
[UserAttributes => ArrayRef[Paws::CognitoIdp::AttributeType]]
[UserContextData => Paws::CognitoIdp::UserContextDataType]
[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.

StartUserImportJob

JobId => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::StartUserImportJob

Returns: a Paws::CognitoIdp::StartUserImportJobResponse instance

Starts the user import.

StopUserImportJob

JobId => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::StopUserImportJob

Returns: a Paws::CognitoIdp::StopUserImportJobResponse instance

Stops the user import job.

TagResource

ResourceArn => Str
[Tags => Paws::CognitoIdp::UserPoolTagsType]

Each argument is described in detail in: Paws::CognitoIdp::TagResource

Returns: a Paws::CognitoIdp::TagResourceResponse instance

Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.

UntagResource

ResourceArn => Str
[TagKeys => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CognitoIdp::UntagResource

Returns: a Paws::CognitoIdp::UntagResourceResponse instance

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account

UpdateAuthEventFeedback

EventId => Str
FeedbackToken => Str
FeedbackValue => Str
Username => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::UpdateAuthEventFeedback

Returns: a Paws::CognitoIdp::UpdateAuthEventFeedbackResponse instance

Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

UpdateDeviceStatus

AccessToken => Str
DeviceKey => Str
[DeviceRememberedStatus => Str]

Each argument is described in detail in: Paws::CognitoIdp::UpdateDeviceStatus

Returns: a Paws::CognitoIdp::UpdateDeviceStatusResponse instance

Updates the device status.

UpdateGroup

GroupName => Str
UserPoolId => Str
[Description => Str]
[Precedence => Int]
[RoleArn => Str]

Each argument is described in detail in: Paws::CognitoIdp::UpdateGroup

Returns: a Paws::CognitoIdp::UpdateGroupResponse instance

Updates the specified group with the specified attributes.

Requires developer credentials.

UpdateIdentityProvider

ProviderName => Str
UserPoolId => Str
[AttributeMapping => Paws::CognitoIdp::AttributeMappingType]
[IdpIdentifiers => ArrayRef[Str|Undef]]
[ProviderDetails => Paws::CognitoIdp::ProviderDetailsType]

Each argument is described in detail in: Paws::CognitoIdp::UpdateIdentityProvider

Returns: a Paws::CognitoIdp::UpdateIdentityProviderResponse instance

Updates identity provider information for a user pool.

UpdateResourceServer

Identifier => Str
Name => Str
UserPoolId => Str
[Scopes => ArrayRef[Paws::CognitoIdp::ResourceServerScopeType]]

Each argument is described in detail in: Paws::CognitoIdp::UpdateResourceServer

Returns: a Paws::CognitoIdp::UpdateResourceServerResponse instance

Updates the name and scopes of resource server. All other fields are read-only.

UpdateUserAttributes

AccessToken => Str
UserAttributes => ArrayRef[Paws::CognitoIdp::AttributeType]

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
[AdminCreateUserConfig => Paws::CognitoIdp::AdminCreateUserConfigType]
[AutoVerifiedAttributes => ArrayRef[Str|Undef]]
[DeviceConfiguration => Paws::CognitoIdp::DeviceConfigurationType]
[EmailConfiguration => Paws::CognitoIdp::EmailConfigurationType]
[EmailVerificationMessage => Str]
[EmailVerificationSubject => Str]
[LambdaConfig => Paws::CognitoIdp::LambdaConfigType]
[MfaConfiguration => Str]
[Policies => Paws::CognitoIdp::UserPoolPolicyType]
[SmsAuthenticationMessage => Str]
[SmsConfiguration => Paws::CognitoIdp::SmsConfigurationType]
[SmsVerificationMessage => Str]
[UserPoolAddOns => Paws::CognitoIdp::UserPoolAddOnsType]
[UserPoolTags => Paws::CognitoIdp::UserPoolTagsType]
[VerificationMessageTemplate => Paws::CognitoIdp::VerificationMessageTemplateType]

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. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool settings with .

UpdateUserPoolClient

ClientId => Str
UserPoolId => Str
[AllowedOAuthFlows => ArrayRef[Str|Undef]]
[AllowedOAuthFlowsUserPoolClient => Bool]
[AllowedOAuthScopes => ArrayRef[Str|Undef]]
[AnalyticsConfiguration => Paws::CognitoIdp::AnalyticsConfigurationType]
[CallbackURLs => ArrayRef[Str|Undef]]
[ClientName => Str]
[DefaultRedirectURI => Str]
[ExplicitAuthFlows => ArrayRef[Str|Undef]]
[LogoutURLs => ArrayRef[Str|Undef]]
[ReadAttributes => ArrayRef[Str|Undef]]
[RefreshTokenValidity => Int]
[SupportedIdentityProviders => ArrayRef[Str|Undef]]
[WriteAttributes => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CognitoIdp::UpdateUserPoolClient

Returns: a Paws::CognitoIdp::UpdateUserPoolClientResponse instance

Updates the specified user pool app client with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool app client settings with .

UpdateUserPoolDomain

CustomDomainConfig => Paws::CognitoIdp::CustomDomainConfigType
Domain => Str
UserPoolId => Str

Each argument is described in detail in: Paws::CognitoIdp::UpdateUserPoolDomain

Returns: a Paws::CognitoIdp::UpdateUserPoolDomainResponse instance

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.

Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.

However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.

When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).

VerifySoftwareToken

UserCode => Str
[AccessToken => Str]
[FriendlyDeviceName => Str]
[Session => Str]

Each argument is described in detail in: Paws::CognitoIdp::VerifySoftwareToken

Returns: a Paws::CognitoIdp::VerifySoftwareTokenResponse instance

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

VerifyUserAttribute

AccessToken => Str
AttributeName => Str
Code => 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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

AdminListAllGroupsForUser(sub { },Username => Str, UserPoolId => Str, [Limit => Int, NextToken => Str])

AdminListAllGroupsForUser(Username => Str, UserPoolId => Str, [Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Groups, passing the object as the first parameter, and the string 'Groups' as the second parameter 

If not, it will return a a Paws::CognitoIdp::AdminListGroupsForUserResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

AdminListAllUserAuthEvents(sub { },Username => Str, UserPoolId => Str, [MaxResults => Int, NextToken => Str])

AdminListAllUserAuthEvents(Username => Str, UserPoolId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - AuthEvents, passing the object as the first parameter, and the string 'AuthEvents' as the second parameter 

If not, it will return a a Paws::CognitoIdp::AdminListUserAuthEventsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllGroups(sub { },UserPoolId => Str, [Limit => Int, NextToken => Str])

ListAllGroups(UserPoolId => Str, [Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Groups, passing the object as the first parameter, and the string 'Groups' as the second parameter 

If not, it will return a a Paws::CognitoIdp::ListGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllIdentityProviders(sub { },UserPoolId => Str, [MaxResults => Int, NextToken => Str])

ListAllIdentityProviders(UserPoolId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Providers, passing the object as the first parameter, and the string 'Providers' as the second parameter 

If not, it will return a a Paws::CognitoIdp::ListIdentityProvidersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllResourceServers(sub { },UserPoolId => Str, [MaxResults => Int, NextToken => Str])

ListAllResourceServers(UserPoolId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ResourceServers, passing the object as the first parameter, and the string 'ResourceServers' as the second parameter 

If not, it will return a a Paws::CognitoIdp::ListResourceServersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUserPoolClients(sub { },UserPoolId => Str, [MaxResults => Int, NextToken => Str])

ListAllUserPoolClients(UserPoolId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - UserPoolClients, passing the object as the first parameter, and the string 'UserPoolClients' as the second parameter 

If not, it will return a a Paws::CognitoIdp::ListUserPoolClientsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUserPools(sub { },MaxResults => Int, [NextToken => Str])

ListAllUserPools(MaxResults => Int, [NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - UserPools, passing the object as the first parameter, and the string 'UserPools' as the second parameter 

If not, it will return a a Paws::CognitoIdp::ListUserPoolsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUsersInGroup(sub { },GroupName => Str, UserPoolId => Str, [Limit => Int, NextToken => Str])

ListAllUsersInGroup(GroupName => Str, UserPoolId => Str, [Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Users, passing the object as the first parameter, and the string 'Users' as the second parameter 

If not, it will return a a Paws::CognitoIdp::ListUsersInGroupResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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