@aws-sdk/client-cognito-identity-provider 3.398.0 → 3.403.0

package/dist-es/models/models_0.js

@@ -773,6 +773,7 @@ export const AuthenticationResultTypeFilterSensitiveLog = (obj) => ({
 });
 export const AdminInitiateAuthResponseFilterSensitiveLog = (obj) => ({
     ...obj,
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
     ...(obj.AuthenticationResult && {
         AuthenticationResult: AuthenticationResultTypeFilterSensitiveLog(obj.AuthenticationResult),
     }),
@@ -803,9 +804,12 @@ export const AdminResetUserPasswordRequestFilterSensitiveLog = (obj) => ({
 export const AdminRespondToAuthChallengeRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
+    ...(obj.ChallengeResponses && { ChallengeResponses: SENSITIVE_STRING }),
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
 });
 export const AdminRespondToAuthChallengeResponseFilterSensitiveLog = (obj) => ({
     ...obj,
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
     ...(obj.AuthenticationResult && {
         AuthenticationResult: AuthenticationResultTypeFilterSensitiveLog(obj.AuthenticationResult),
     }),
@@ -845,10 +849,12 @@ export const AdminUserGlobalSignOutRequestFilterSensitiveLog = (obj) => ({
 export const AssociateSoftwareTokenRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }),
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
 });
 export const AssociateSoftwareTokenResponseFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.SecretCode && { SecretCode: SENSITIVE_STRING }),
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
 });
 export const ChangePasswordRequestFilterSensitiveLog = (obj) => ({
     ...obj,
@@ -860,18 +866,23 @@ export const ConfirmDeviceRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }),
 });
+export const UserContextDataTypeFilterSensitiveLog = (obj) => ({
+    ...obj,
+});
 export const ConfirmForgotPasswordRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
     ...(obj.SecretHash && { SecretHash: SENSITIVE_STRING }),
     ...(obj.Username && { Username: SENSITIVE_STRING }),
     ...(obj.Password && { Password: SENSITIVE_STRING }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
 });
 export const ConfirmSignUpRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
     ...(obj.SecretHash && { SecretHash: SENSITIVE_STRING }),
     ...(obj.Username && { Username: SENSITIVE_STRING }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
 });
 export const UserPoolClientTypeFilterSensitiveLog = (obj) => ({
     ...obj,
@@ -922,6 +933,7 @@ export const ForgotPasswordRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
     ...(obj.SecretHash && { SecretHash: SENSITIVE_STRING }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
     ...(obj.Username && { Username: SENSITIVE_STRING }),
 });
 export const GetDeviceRequestFilterSensitiveLog = (obj) => ({
@@ -967,9 +979,11 @@ export const InitiateAuthRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.AuthParameters && { AuthParameters: SENSITIVE_STRING }),
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
 });
 export const InitiateAuthResponseFilterSensitiveLog = (obj) => ({
     ...obj,
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
     ...(obj.AuthenticationResult && {
         AuthenticationResult: AuthenticationResultTypeFilterSensitiveLog(obj.AuthenticationResult),
     }),
@@ -1003,14 +1017,19 @@ export const ResendConfirmationCodeRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
     ...(obj.SecretHash && { SecretHash: SENSITIVE_STRING }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
     ...(obj.Username && { Username: SENSITIVE_STRING }),
 });
 export const RespondToAuthChallengeRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.ClientId && { ClientId: SENSITIVE_STRING }),
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
+    ...(obj.ChallengeResponses && { ChallengeResponses: SENSITIVE_STRING }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
 });
 export const RespondToAuthChallengeResponseFilterSensitiveLog = (obj) => ({
     ...obj,
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
     ...(obj.AuthenticationResult && {
         AuthenticationResult: AuthenticationResultTypeFilterSensitiveLog(obj.AuthenticationResult),
     }),

package/dist-es/models/models_1.js

@@ -49,6 +49,7 @@ export const SignUpRequestFilterSensitiveLog = (obj) => ({
     ...(obj.ValidationData && {
         ValidationData: obj.ValidationData.map((item) => AttributeTypeFilterSensitiveLog(item)),
     }),
+    ...(obj.UserContextData && { UserContextData: SENSITIVE_STRING }),
 });
 export const UpdateAuthEventFeedbackRequestFilterSensitiveLog = (obj) => ({
     ...obj,
@@ -77,6 +78,12 @@ export const UpdateUserPoolClientResponseFilterSensitiveLog = (obj) => ({
 export const VerifySoftwareTokenRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }),
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
+    ...(obj.UserCode && { UserCode: SENSITIVE_STRING }),
+});
+export const VerifySoftwareTokenResponseFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.Session && { Session: SENSITIVE_STRING }),
 });
 export const VerifyUserAttributeRequestFilterSensitiveLog = (obj) => ({
     ...obj,

package/dist-types/commands/AdminCreateUserCommand.d.ts

@@ -195,6 +195,66 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
  * @throws {@link CognitoIdentityProviderServiceException}
  * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
+ * @example An AdminCreateUser request for for a test user named John.
+ * ```javascript
+ * // This request submits a value for all possible parameters for AdminCreateUser.
+ * const input = {
+ *   "DesiredDeliveryMediums": [
+ *     "SMS"
+ *   ],
+ *   "MessageAction": "SUPPRESS",
+ *   "TemporaryPassword": "This-is-my-test-99!",
+ *   "UserAttributes": [
+ *     {
+ *       "Name": "name",
+ *       "Value": "John"
+ *     },
+ *     {
+ *       "Name": "phone_number",
+ *       "Value": "+12065551212"
+ *     },
+ *     {
+ *       "Name": "email",
+ *       "Value": "testuser@example.com"
+ *     }
+ *   ],
+ *   "UserPoolId": "us-east-1_EXAMPLE",
+ *   "Username": "testuser"
+ * };
+ * const command = new AdminCreateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "User": {
+ *     "Attributes": [
+ *       {
+ *         "Name": "sub",
+ *         "Value": "d16b4aa8-8633-4abd-93b3-5062a8e1b5f8"
+ *       },
+ *       {
+ *         "Name": "name",
+ *         "Value": "John"
+ *       },
+ *       {
+ *         "Name": "phone_number",
+ *         "Value": "+12065551212"
+ *       },
+ *       {
+ *         "Name": "email",
+ *         "Value": "testuser@example.com"
+ *       }
+ *     ],
+ *     "Enabled": true,
+ *     "UserCreateDate": 1689980857.949,
+ *     "UserLastModifiedDate": 1689980857.949,
+ *     "UserStatus": "FORCE_CHANGE_PASSWORD",
+ *     "Username": "testuser"
+ *   }
+ * }
+ * *\/
+ * // example id: an-admincreateuser-request-for-for-a-test-user-named-john-1689980900481
+ * ```
+ *
  */
 export declare class AdminCreateUserCommand extends $Command<AdminCreateUserCommandInput, AdminCreateUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminCreateUserCommandInput;

package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts

@@ -41,7 +41,8 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
  *                     Developer Guide</i>.</p>
  *          </note>
  *          <p>Updates the specified user's attributes, including developer attributes, as an
- *             administrator. Works on any user.</p>
+ *             administrator. Works on any user. To delete an attribute from your user, submit the
+ *             attribute in your API request with a blank value.</p>
  *          <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
  *             attribute name.</p>
  *          <p>In addition to updating user attributes, this API can also be used to mark phone and

package/dist-types/commands/CreateUserPoolClientCommand.d.ts

@@ -202,6 +202,134 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
  * @throws {@link CognitoIdentityProviderServiceException}
  * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
+ * @example Example user pool app client with email and username sign-in
+ * ```javascript
+ * // The following example creates an app client with all configurable properties set to an example value. The resulting user pool client connects to an analytics client, allows sign-in with username and password, and has two external identity providers associated with it.
+ * const input = {
+ *   "AccessTokenValidity": 6,
+ *   "AllowedOAuthFlows": [
+ *     "code"
+ *   ],
+ *   "AllowedOAuthFlowsUserPoolClient": true,
+ *   "AllowedOAuthScopes": [
+ *     "aws.cognito.signin.user.admin",
+ *     "openid"
+ *   ],
+ *   "AnalyticsConfiguration": {
+ *     "ApplicationId": "d70b2ba36a8c4dc5a04a0451a31a1e12",
+ *     "ExternalId": "my-external-id",
+ *     "RoleArn": "arn:aws:iam::123456789012:role/test-cognitouserpool-role",
+ *     "UserDataShared": true
+ *   },
+ *   "CallbackURLs": [
+ *     "https://example.com",
+ *     "http://localhost",
+ *     "myapp://example"
+ *   ],
+ *   "ClientName": "my-test-app-client",
+ *   "DefaultRedirectURI": "https://example.com",
+ *   "ExplicitAuthFlows": [
+ *     "ALLOW_ADMIN_USER_PASSWORD_AUTH",
+ *     "ALLOW_USER_PASSWORD_AUTH",
+ *     "ALLOW_REFRESH_TOKEN_AUTH"
+ *   ],
+ *   "GenerateSecret": true,
+ *   "IdTokenValidity": 6,
+ *   "LogoutURLs": [
+ *     "https://example.com/logout"
+ *   ],
+ *   "PreventUserExistenceErrors": "ENABLED",
+ *   "ReadAttributes": [
+ *     "email",
+ *     "address",
+ *     "preferred_username"
+ *   ],
+ *   "RefreshTokenValidity": 6,
+ *   "SupportedIdentityProviders": [
+ *     "SignInWithApple",
+ *     "MySSO"
+ *   ],
+ *   "TokenValidityUnits": {
+ *     "AccessToken": "hours",
+ *     "IdToken": "minutes",
+ *     "RefreshToken": "days"
+ *   },
+ *   "UserPoolId": "us-east-1_EXAMPLE",
+ *   "WriteAttributes": [
+ *     "family_name",
+ *     "email"
+ *   ]
+ * };
+ * const command = new CreateUserPoolClientCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "UserPoolClient": {
+ *     "AccessTokenValidity": 6,
+ *     "AllowedOAuthFlows": [
+ *       "code"
+ *     ],
+ *     "AllowedOAuthFlowsUserPoolClient": true,
+ *     "AllowedOAuthScopes": [
+ *       "aws.cognito.signin.user.admin",
+ *       "openid"
+ *     ],
+ *     "AnalyticsConfiguration": {
+ *       "ApplicationId": "d70b2ba36a8c4dc5a04a0451a31a1e12",
+ *       "ExternalId": "my-external-id",
+ *       "RoleArn": "arn:aws:iam::123456789012:role/test-cognitouserpool-role",
+ *       "UserDataShared": true
+ *     },
+ *     "AuthSessionValidity": 3,
+ *     "CallbackURLs": [
+ *       "https://example.com",
+ *       "http://localhost",
+ *       "myapp://example"
+ *     ],
+ *     "ClientId": "26cb2c60kq7nbmas7rbme9b6pp",
+ *     "ClientName": "my-test-app-client",
+ *     "ClientSecret": "13ka4h7u28d9oo44tqpq9djqsfvhvu8rk4d2ighvpu0k8fj1c2r9",
+ *     "CreationDate": 1689885426.107,
+ *     "DefaultRedirectURI": "https://example.com",
+ *     "EnablePropagateAdditionalUserContextData": false,
+ *     "EnableTokenRevocation": true,
+ *     "ExplicitAuthFlows": [
+ *       "ALLOW_USER_PASSWORD_AUTH",
+ *       "ALLOW_ADMIN_USER_PASSWORD_AUTH",
+ *       "ALLOW_REFRESH_TOKEN_AUTH"
+ *     ],
+ *     "IdTokenValidity": 6,
+ *     "LastModifiedDate": 1689885426.107,
+ *     "LogoutURLs": [
+ *       "https://example.com/logout"
+ *     ],
+ *     "PreventUserExistenceErrors": "ENABLED",
+ *     "ReadAttributes": [
+ *       "address",
+ *       "preferred_username",
+ *       "email"
+ *     ],
+ *     "RefreshTokenValidity": 6,
+ *     "SupportedIdentityProviders": [
+ *       "SignInWithApple",
+ *       "MySSO"
+ *     ],
+ *     "TokenValidityUnits": {
+ *       "AccessToken": "hours",
+ *       "IdToken": "minutes",
+ *       "RefreshToken": "days"
+ *     },
+ *     "UserPoolId": "us-east-1_EXAMPLE",
+ *     "WriteAttributes": [
+ *       "family_name",
+ *       "email"
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: example-user-pool-app-client-with-email-and-username-sign-in-1689885750745
+ * ```
+ *
  */
 export declare class CreateUserPoolClientCommand extends $Command<CreateUserPoolClientCommandInput, CreateUserPoolClientCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: CreateUserPoolClientCommandInput;