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.
Update-CGIPUserPoolClient-UserPoolId <String>-AllowedOAuthFlow <String[]>-AllowedOAuthFlowsUserPoolClient <Boolean>-AllowedOAuthScope <String[]>-AnalyticsConfiguration_ApplicationId <String>-CallbackURLs <String[]>-ClientId <String>-ClientName <String>-DefaultRedirectURI <String>-ExplicitAuthFlow <String[]>-AnalyticsConfiguration_ExternalId <String>-LogoutURLs <String[]>-PreventUserExistenceError <PreventUserExistenceErrorTypes>-ReadAttribute <String[]>-RefreshTokenValidity <Int32>-AnalyticsConfiguration_RoleArn <String>-SupportedIdentityProvider <String[]>-AnalyticsConfiguration_UserDataShared <Boolean>-WriteAttribute <String[]>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
code
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AllowedOAuthFlows |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
OAuth
scopes. Currently supported values are "phone"
, "email"
, "openid"
, and "Cognito"
. In addition to these values, custom scopes created in Resource Servers are also supported. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AllowedOAuthScopes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
UserDataShared
is true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
CallbackURLs
list.A redirect URI must:Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ALLOW_
prefix are deprecated in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_
prefix cannot be used along with values without ALLOW_
prefix.Valid values include:ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH
: Enable SRP based authentication.ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ExplicitAuthFlows |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException
exception if the user does not exist in the user pool.Valid values include:ENABLED
- This prevents user existence-related errors.LEGACY
- This represents the old behavior of Cognito where user existence related errors are not prevented.PreventUserExistenceErrors
will default to ENABLED
for newly created user pool clients if no value is provided. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreventUserExistenceErrors |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ReadAttributes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SupportedIdentityProviders |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | WriteAttributes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfileName, StoredCredentials |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SecretAccessKey, SK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
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) |
AWS Tools for PowerShell: 2.x.y.z