AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Cognito Identity Provider UpdateUserPool API operation.

Syntax

Update-CGIPUserPool
-UserPoolId <String>
-UserPoolAddOns_AdvancedSecurityMode <AdvancedSecurityModeType>
-AdminCreateUserConfig_AllowAdminCreateUserOnly <Boolean>
-AutoVerifiedAttribute <String[]>
-DeviceConfiguration_ChallengeRequiredOnNewDevice <Boolean>
-EmailConfiguration_ConfigurationSet <String>
-LambdaConfig_CreateAuthChallenge <String>
-LambdaConfig_CustomMessage <String>
-VerificationMessageTemplate_DefaultEmailOption <DefaultEmailOptionType>
-LambdaConfig_DefineAuthChallenge <String>
-DeviceConfiguration_DeviceOnlyRememberedOnUserPrompt <Boolean>
-InviteMessageTemplate_EmailMessage <String>
-VerificationMessageTemplate_EmailMessage <String>
-VerificationMessageTemplate_EmailMessageByLink <String>
-EmailConfiguration_EmailSendingAccount <EmailSendingAccountType>
-InviteMessageTemplate_EmailSubject <String>
-VerificationMessageTemplate_EmailSubject <String>
-VerificationMessageTemplate_EmailSubjectByLink <String>
-EmailVerificationMessage <String>
-EmailVerificationSubject <String>
-SmsConfiguration_ExternalId <String>
-EmailConfiguration_From <String>
-LambdaConfig_KMSKeyID <String>
-CustomEmailSender_LambdaArn <String>
-CustomSMSSender_LambdaArn <String>
-CustomEmailSender_LambdaVersion <CustomEmailSenderLambdaVersionType>
-CustomSMSSender_LambdaVersion <CustomSMSSenderLambdaVersionType>
-MfaConfiguration <UserPoolMfaType>
-PasswordPolicy_MinimumLength <Int32>
-LambdaConfig_PostAuthentication <String>
-LambdaConfig_PostConfirmation <String>
-LambdaConfig_PreAuthentication <String>
-LambdaConfig_PreSignUp <String>
-LambdaConfig_PreTokenGeneration <String>
-AccountRecoverySetting_RecoveryMechanism <RecoveryOptionType[]>
-EmailConfiguration_ReplyToEmailAddress <String>
-PasswordPolicy_RequireLowercase <Boolean>
-PasswordPolicy_RequireNumber <Boolean>
-PasswordPolicy_RequireSymbol <Boolean>
-PasswordPolicy_RequireUppercase <Boolean>
-SmsAuthenticationMessage <String>
-VerificationMessageTemplate_SmsMessage <String>
-InviteMessageTemplate_SMSMessage <String>
-SmsVerificationMessage <String>
-SmsConfiguration_SnsCallerArn <String>
-EmailConfiguration_SourceArn <String>
-PasswordPolicy_TemporaryPasswordValidityDay <Int32>
-AdminCreateUserConfig_UnusedAccountValidityDay <Int32>
-LambdaConfig_UserMigration <String>
-UserPoolTag <Hashtable>
-LambdaConfig_VerifyAuthChallengeResponse <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value. This action might generate an SMS text message. Starting June 1, 2021, U.S. telecom carriers require that you register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Cognito will use the the registered number automatically. Otherwise, Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In sandbox mode, you’ll have limitations, such as sending messages to only verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see SMS message settings for Cognito User Pools in the Amazon Cognito Developer Guide.

Parameters

-AccountRecoverySetting_RecoveryMechanism <RecoveryOptionType[]>
The list of RecoveryOptionTypes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountRecoverySetting_RecoveryMechanisms
-AdminCreateUserConfig_AllowAdminCreateUserOnly <Boolean>
Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdminCreateUserConfig_UnusedAccountValidityDay <Int32>
The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7. If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminCreateUserConfig_UnusedAccountValidityDays
-AutoVerifiedAttribute <String[]>
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoVerifiedAttributes
-CustomEmailSender_LambdaArn <String>
The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send email notifications to users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomEmailSender_LambdaArn
-CustomEmailSender_LambdaVersion <CustomEmailSenderLambdaVersionType>
The Lambda version represents the signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomEmailSender_LambdaVersion
-CustomSMSSender_LambdaArn <String>
The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send SMS notifications to users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomSMSSender_LambdaArn
-CustomSMSSender_LambdaVersion <CustomSMSSenderLambdaVersionType>
The Lambda version represents the signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomSMSSender_LambdaVersion
-DeviceConfiguration_ChallengeRequiredOnNewDevice <Boolean>
Indicates whether a challenge is required on a new device. Only applicable to a new device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceConfiguration_DeviceOnlyRememberedOnUserPrompt <Boolean>
If true, a device is only remembered on user prompt.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailConfiguration_ConfigurationSet <String>
The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:
  • Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as SNS and CloudWatch.
  • IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailConfiguration_EmailSendingAccount <EmailSendingAccountType>
Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values:
COGNITO_DEFAULT
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide.The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter. If EmailSendingAccount is COGNITO_DEFAULT, the following parameters aren't allowed:
  • EmailVerificationMessage
  • EmailVerificationSubject
  • InviteMessageTemplate.EmailMessage
  • InviteMessageTemplate.EmailSubject
  • VerificationMessageTemplate.EmailMessage
  • VerificationMessageTemplate.EmailMessageByLink
  • VerificationMessageTemplate.EmailSubject,
  • VerificationMessageTemplate.EmailSubjectByLink
DEVELOPER EmailSendingAccount is required.
DEVELOPER
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your account.If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter.Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of IAM role, in your account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailConfiguration_From <String>
Identifies either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address will appear before the body of the email.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailConfiguration_ReplyToEmailAddress <String>
The destination to which the receiver of the email should reply to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailConfiguration_SourceArn <String>
The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
  • If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account.
  • If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailVerificationMessage <String>
The contents of the email verification message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailVerificationSubject <String>
The subject of the email verification message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InviteMessageTemplate_EmailMessage <String>
The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminCreateUserConfig_InviteMessageTemplate_EmailMessage
-InviteMessageTemplate_EmailSubject <String>
The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminCreateUserConfig_InviteMessageTemplate_EmailSubject
-InviteMessageTemplate_SMSMessage <String>
The message template for SMS messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminCreateUserConfig_InviteMessageTemplate_SMSMessage
-LambdaConfig_CreateAuthChallenge <String>
Creates an authentication challenge.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_CustomMessage <String>
A custom Message Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_DefineAuthChallenge <String>
Defines the authentication challenge.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_KMSKeyID <String>
The Amazon Resource Name of Key Management Service Customer master keys . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_PostAuthentication <String>
A post-authentication Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_PostConfirmation <String>
A post-confirmation Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_PreAuthentication <String>
A pre-authentication Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_PreSignUp <String>
A pre-registration Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_PreTokenGeneration <String>
A Lambda trigger that is invoked before token generation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_UserMigration <String>
The user migration Lambda config type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig_VerifyAuthChallengeResponse <String>
Verifies the authentication challenge response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MfaConfiguration <UserPoolMfaType>
Can be one of the following values:
  • OFF - MFA tokens are not required and cannot be specified during user registration.
  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
  • OPTIONAL - Users have the option when registering to create an MFA token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the UserPoolId parameter. The -PassThru parameter is deprecated, use -Select '^UserPoolId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PasswordPolicy_MinimumLength <Int32>
The minimum length of the password policy that you have set. Cannot be less than 6.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_MinimumLength
-PasswordPolicy_RequireLowercase <Boolean>
In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_RequireLowercase
-PasswordPolicy_RequireNumber <Boolean>
In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_RequireNumbers
-PasswordPolicy_RequireSymbol <Boolean>
In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_RequireSymbols
-PasswordPolicy_RequireUppercase <Boolean>
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_RequireUppercase
-PasswordPolicy_TemporaryPasswordValidityDay <Int32>
In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the deprecated UnusedAccountValidityDays value for that user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_TemporaryPasswordValidityDays
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentityProvider.Model.UpdateUserPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SmsAuthenticationMessage <String>
The contents of the SMS authentication message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SmsConfiguration_ExternalId <String>
The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SmsConfiguration_SnsCallerArn <String>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your account which Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SmsVerificationMessage <String>
A container with information about the SMS verification message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserPoolAddOns_AdvancedSecurityMode <AdvancedSecurityModeType>
The advanced security mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserPoolId <String>
The user pool ID for the user pool you want to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-UserPoolTag <Hashtable>
The tag keys and values to assign to the 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUserPoolTags
-VerificationMessageTemplate_DefaultEmailOption <DefaultEmailOptionType>
The default email option.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_EmailMessage <String>
The email message template. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_EmailMessageByLink <String>
The email message template for sending a confirmation link to the user. EmailMessageByLink is allowed only if EmailSendingAccount is DEVELOPER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_EmailSubject <String>
The subject line for the email message template. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_EmailSubjectByLink <String>
The subject line for the email message template for sending a confirmation link to the user. EmailSubjectByLink is allowed only EmailSendingAccount is DEVELOPER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_SmsMessage <String>
The SMS message template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.CognitoIdentityProvider.Model.UpdateUserPoolResponse
This cmdlet does not generate any output.The service response (type Amazon.CognitoIdentityProvider.Model.UpdateUserPoolResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z