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>
-UserAttributeUpdateSettings_AttributesRequireVerificationBeforeUpdate <String[]>
-AutoVerifiedAttribute <String[]>
-DeviceConfiguration_ChallengeRequiredOnNewDevice <Boolean>
-EmailConfiguration_ConfigurationSet <String>
-LambdaConfig_CreateAuthChallenge <String>
-AdvancedSecurityAdditionalFlows_CustomAuthMode <AdvancedSecurityEnabledModeType>
-LambdaConfig_CustomMessage <String>
-VerificationMessageTemplate_DefaultEmailOption <DefaultEmailOptionType>
-LambdaConfig_DefineAuthChallenge <String>
-DeletionProtection <DeletionProtectionType>
-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>
-PreTokenGenerationConfig_LambdaArn <String>
-CustomEmailSender_LambdaVersion <CustomEmailSenderLambdaVersionType>
-CustomSMSSender_LambdaVersion <CustomSMSSenderLambdaVersionType>
-PreTokenGenerationConfig_LambdaVersion <PreTokenGenerationLambdaVersionType>
-MfaConfiguration <UserPoolMfaType>
-PasswordPolicy_MinimumLength <Int32>
-PasswordPolicy_PasswordHistorySize <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>
-SmsConfiguration_SnsRegion <String>
-EmailConfiguration_SourceArn <String>
-PasswordPolicy_TemporaryPasswordValidityDay <Int32>
-AdminCreateUserConfig_UnusedAccountValidityDay <Int32>
-LambdaConfig_UserMigration <String>
-UserPoolTag <Hashtable>
-LambdaConfig_VerifyAuthChallengeResponse <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCognitoIdentityProviderConfig>

Description

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able 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 Servicesservice, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. 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, Amazon Cognito sets it to its default value. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more

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 a new account that hasn't signed in 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 no longer be an available parameter for that user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminCreateUserConfig_UnusedAccountValidityDays
-AdvancedSecurityAdditionalFlows_CustomAuthMode <AdvancedSecurityEnabledModeType>
The operating mode of advanced security features in custom authentication with Custom authentication challenge Lambda triggers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUserPoolAddOns_AdvancedSecurityAdditionalFlows_CustomAuthMode
-AutoVerifiedAttribute <String[]>
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoVerifiedAttributes
-ClientConfig <AmazonCognitoIdentityProviderConfig>
Amazon.PowerShell.Cmdlets.CGIP.AmazonCognitoIdentityProviderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomEmailSender_LambdaArn <String>
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomEmailSender_LambdaArn
-CustomEmailSender_LambdaVersion <CustomEmailSenderLambdaVersionType>
The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.You must use a LambdaVersion of V1_0 with a custom sender function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomEmailSender_LambdaVersion
-CustomSMSSender_LambdaArn <String>
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomSMSSender_LambdaArn
-CustomSMSSender_LambdaVersion <CustomSMSSenderLambdaVersionType>
The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.You must use a LambdaVersion of V1_0 with a custom sender function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_CustomSMSSender_LambdaVersion
-DeletionProtection <DeletionProtectionType>
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceConfiguration_ChallengeRequiredOnNewDevice <Boolean>
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceConfiguration_DeviceOnlyRememberedOnUserPrompt <Boolean>
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.
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 Simple Email Service. 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 Simple Email Service 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 and Amazon CloudWatch
IP pool management
When leasing dedicated IP addresses with Amazon Simple Email Service, 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 uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service 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 less than 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 the Amazon Cognito Developer Guide.The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.
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 Amazon Web Services account.If you use this option, 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 role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email 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>
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 appears 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailConfiguration_SourceArn <String>
The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a SourceArn email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide 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 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.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailVerificationMessage <String>
This parameter is no longer used. See VerificationMessageTemplateType.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailVerificationSubject <String>
This parameter is no longer used. See VerificationMessageTemplateType.
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 (ARN) of an KMS key. 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>
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig, its value must be identical to PreTokenGeneration. For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig.You can set
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>
Possible values include:
  • OFF - MFA tokens aren't required and can't be specified during user registration.
  • ON - MFA tokens are required for all user registrations. You can only specify ON when you're 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 in the policy that you have set. This value can't be less than 6.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_MinimumLength
-PasswordPolicy_PasswordHistorySize <Int32>
The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize.Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to 0 or don't provide it. To activate this setting, advanced security features must be active in your user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_PasswordHistorySize
-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>
The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7. If you submit a value of 0, Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicies_PasswordPolicy_TemporaryPasswordValidityDays
-PreTokenGenerationConfig_LambdaArn <String>
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.This parameter and the PreTokenGeneration property of LambdaConfig have the same value. For new instances of pre token generation triggers, set LambdaArn.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_PreTokenGenerationConfig_LambdaArn
-PreTokenGenerationConfig_LambdaVersion <PreTokenGenerationLambdaVersionType>
The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLambdaConfig_PreTokenGenerationConfig_LambdaVersion
-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 provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates 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 SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SmsConfiguration_SnsRegion <String>
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region. Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SmsVerificationMessage <String>
This parameter is no longer used. See VerificationMessageTemplateType.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserAttributeUpdateSettings_AttributesRequireVerificationBeforeUpdate <String[]>
Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserPoolAddOns_AdvancedSecurityMode <AdvancedSecurityModeType>
The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
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 template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_EmailMessageByLink <String>
The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_EmailSubject <String>
The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
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. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VerificationMessageTemplate_SmsMessage <String>
The template for SMS messages that Amazon Cognito sends to your users.
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) be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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