@aws-sdk/client-cognito-identity-provider 3.758.0 → 3.768.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/README.md +4 -61
  2. package/dist-cjs/index.js +121 -88
  3. package/dist-es/models/models_0.js +13 -4
  4. package/dist-es/models/models_1.js +4 -0
  5. package/dist-es/protocols/Aws_json1_1.js +13 -1
  6. package/dist-types/CognitoIdentityProvider.d.ts +5 -62
  7. package/dist-types/CognitoIdentityProviderClient.d.ts +5 -62
  8. package/dist-types/commands/AddCustomAttributesCommand.d.ts +0 -3
  9. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -2
  10. package/dist-types/commands/AdminCreateUserCommand.d.ts +12 -12
  11. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
  12. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +10 -13
  13. package/dist-types/commands/AdminEnableUserCommand.d.ts +1 -1
  14. package/dist-types/commands/AdminGetDeviceCommand.d.ts +1 -1
  15. package/dist-types/commands/AdminGetUserCommand.d.ts +4 -3
  16. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +3 -0
  17. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +11 -12
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +1 -1
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -12
  20. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +0 -3
  21. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +1 -1
  22. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +10 -7
  23. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +20 -20
  24. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +0 -12
  25. package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
  26. package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +2 -3
  27. package/dist-types/commands/ConfirmDeviceCommand.d.ts +4 -0
  28. package/dist-types/commands/ConfirmSignUpCommand.d.ts +7 -10
  29. package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
  30. package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +0 -3
  31. package/dist-types/commands/CreateUserImportJobCommand.d.ts +1 -3
  32. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +4 -5
  33. package/dist-types/commands/CreateUserPoolCommand.d.ts +8 -10
  34. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +3 -3
  35. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +3 -3
  36. package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
  37. package/dist-types/commands/DeleteUserPoolCommand.d.ts +7 -1
  38. package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +1 -1
  39. package/dist-types/commands/DescribeUserPoolCommand.d.ts +1 -1
  40. package/dist-types/commands/ForgetDeviceCommand.d.ts +2 -2
  41. package/dist-types/commands/ForgotPasswordCommand.d.ts +6 -11
  42. package/dist-types/commands/GetCSVHeaderCommand.d.ts +26 -2
  43. package/dist-types/commands/GetDeviceCommand.d.ts +2 -1
  44. package/dist-types/commands/GetGroupCommand.d.ts +23 -2
  45. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +3 -1
  46. package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +22 -1
  47. package/dist-types/commands/GetSigningCertificateCommand.d.ts +26 -5
  48. package/dist-types/commands/GetUICustomizationCommand.d.ts +5 -5
  49. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +2 -3
  50. package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +9 -3
  51. package/dist-types/commands/GetUserCommand.d.ts +1 -1
  52. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +39 -1
  53. package/dist-types/commands/InitiateAuthCommand.d.ts +5 -2
  54. package/dist-types/commands/ListDevicesCommand.d.ts +1 -1
  55. package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
  56. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +2 -1
  57. package/dist-types/commands/ListResourceServersCommand.d.ts +2 -1
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
  59. package/dist-types/commands/ListUserImportJobsCommand.d.ts +3 -1
  60. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -1
  61. package/dist-types/commands/ListUserPoolsCommand.d.ts +2 -2
  62. package/dist-types/commands/ListUsersCommand.d.ts +2 -1
  63. package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -1
  64. package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +9 -2
  65. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +5 -2
  66. package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +3 -1
  67. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +24 -5
  68. package/dist-types/commands/SetUICustomizationCommand.d.ts +23 -10
  69. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +0 -3
  70. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +2 -1
  71. package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -1
  72. package/dist-types/commands/SignUpCommand.d.ts +3 -5
  73. package/dist-types/commands/StartUserImportJobCommand.d.ts +3 -1
  74. package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +4 -6
  75. package/dist-types/commands/StopUserImportJobCommand.d.ts +3 -1
  76. package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
  77. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +13 -3
  78. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -2
  79. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
  80. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +4 -1
  81. package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -5
  82. package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -1
  83. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +4 -5
  84. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +7 -4
  85. package/dist-types/commands/UpdateUserPoolCommand.d.ts +8 -7
  86. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +4 -3
  87. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +5 -3
  88. package/dist-types/index.d.ts +5 -62
  89. package/dist-types/models/models_0.d.ts +749 -656
  90. package/dist-types/models/models_1.d.ts +837 -560
  91. package/dist-types/ts3.4/models/models_0.d.ts +9 -6
  92. package/dist-types/ts3.4/models/models_1.d.ts +6 -1
  93. package/package.json +1 -1
@@ -27,27 +27,10 @@ declare const AdminUpdateUserAttributesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <note>
31
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
32
- * require you to register an origination phone number before you can send SMS messages
33
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
34
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
35
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
36
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
37
- * in.</p>
38
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
39
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
40
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
41
- * mode</a>
42
- * </i>, you can send messages only to verified phone
43
- * numbers. After you test your app while in the sandbox environment, you can move out
44
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
45
- * Developer Guide</i>.</p>
46
- * </note>
47
- * <p>Updates the specified user's attributes. To delete an attribute from your user,
30
+ * <p>Updates the specified user's attributes. To delete an attribute from your user,
48
31
  * submit the attribute in your API request with a blank value.</p>
49
- * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
50
- * attribute name.</p>
32
+ * <p>For custom attributes, you must add a <code>custom:</code> prefix to the attribute
33
+ * name, for example <code>custom:department</code>.</p>
51
34
  * <p>This operation can set a user's email address or phone number as verified and
52
35
  * permit immediate sign-in in user pools that require verification of these attributes. To
53
36
  * do this, set the <code>email_verified</code> or <code>phone_number_verified</code>
@@ -72,6 +55,23 @@ declare const AdminUpdateUserAttributesCommand_base: {
72
55
  * </li>
73
56
  * </ul>
74
57
  * </note>
58
+ * <note>
59
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
60
+ * require you to register an origination phone number before you can send SMS messages
61
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
62
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
63
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
64
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
65
+ * in.</p>
66
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
67
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
68
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
69
+ * mode</a>
70
+ * </i>, you can send messages only to verified phone
71
+ * numbers. After you test your app while in the sandbox environment, you can move out
72
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
73
+ * Developer Guide</i>.</p>
74
+ * </note>
75
75
  * @example
76
76
  * Use a bare-bones client and the command you need to make an API call.
77
77
  * ```javascript
@@ -33,18 +33,6 @@ declare const AssociateSoftwareTokenCommand_base: {
33
33
  * the user's access token, or a session string from a challenge response that you received
34
34
  * from Amazon Cognito.</p>
35
35
  * <note>
36
- * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
37
- * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
38
- * token and your user pool doesn't require MFA, the user can then authenticate with
39
- * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
40
- * generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
41
- * each time your user signs in. Complete setup with
42
- * <code>AssociateSoftwareToken</code> and <code>VerifySoftwareToken</code>.</p>
43
- * <p>After you set up software token MFA for your user, Amazon Cognito generates a
44
- * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
45
- * this challenge with your user's TOTP.</p>
46
- * </note>
47
- * <note>
48
36
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
49
37
  * this operation, you can't use IAM credentials to authorize requests, and you can't
50
38
  * grant IAM permissions in policies. For more information about authorization models in
@@ -27,7 +27,7 @@ declare const ChangePasswordCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Changes the password for a specified user in a user pool.</p>
30
+ * <p>Changes the password for the currently signed-in user.</p>
31
31
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
32
32
  * <note>
33
33
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -27,9 +27,8 @@ declare const CompleteWebAuthnRegistrationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Completes registration of a passkey authenticator for the current user. Your
31
- * application provides data from a successful registration request with the data from the
32
- * output of a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StartWebAuthnRegistration.html"> StartWebAuthnRegistration</a>.</p>
30
+ * <p>Completes registration of a passkey authenticator for the currently signed-in
31
+ * user.</p>
33
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
34
33
  * @example
35
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -67,6 +67,10 @@ declare const ConfirmDeviceCommand_base: {
67
67
  * @see {@link ConfirmDeviceCommandOutput} for command's `response` shape.
68
68
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
69
69
  *
70
+ * @throws {@link DeviceKeyExistsException} (client fault)
71
+ * <p>This exception is thrown when a user attempts to confirm a device with a device key
72
+ * that already exists.</p>
73
+ *
70
74
  * @throws {@link ForbiddenException} (client fault)
71
75
  * <p>This exception is thrown when WAF doesn't allow your request based on a web
72
76
  * ACL that's associated with your user pool.</p>
@@ -27,18 +27,15 @@ declare const ConfirmSignUpCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This public API operation submits a code that Amazon Cognito sent to your user when they signed
31
- * up in your user pool via the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html">SignUp</a>
32
- * API operation. After your user enters their code, they confirm ownership of the email
33
- * address or phone number that they provided, and their user account becomes active.
34
- * Depending on your user pool configuration, your users will receive their confirmation
35
- * code in an email or SMS message.</p>
30
+ * <p>Confirms the account of a new user. This public API operation submits a code that
31
+ * Amazon Cognito sent to your user when they signed up in your user pool. After your user enters
32
+ * their code, they confirm ownership of the email address or phone number that they
33
+ * provided, and their user account becomes active. Depending on your user pool
34
+ * configuration, your users will receive their confirmation code in an email or SMS
35
+ * message.</p>
36
36
  * <p>Local users who signed up in your user pool are the only type of user who can confirm
37
37
  * sign-up with a code. Users who federate through an external identity provider (IdP) have
38
- * already been confirmed by their IdP. Administrator-created users, users created with the
39
- * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html">AdminCreateUser</a> API operation, confirm their accounts when they respond to
40
- * their invitation email message and choose a password. They do not receive a confirmation
41
- * code. Instead, they receive a temporary password.</p>
38
+ * already been confirmed by their IdP.</p>
42
39
  * <note>
43
40
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
44
41
  * this operation, you can't use IAM credentials to authorize requests, and you can't
@@ -28,7 +28,7 @@ declare const CreateGroupCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates a new group in the specified user pool. For more information about user pool
31
- * groups see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html">Adding groups to a user pool</a>.</p>
31
+ * groups, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html">Adding groups to a user pool</a>.</p>
32
32
  * <note>
33
33
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
34
34
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -41,9 +41,6 @@ declare const CreateManagedLoginBrandingCommand_base: {
41
41
  * doesn't require that you pass all parameters in one request and preserves existing
42
42
  * style settings that you don't specify. If your request is larger than 2MB, separate it
43
43
  * into multiple requests, each with a size smaller than the limit. </p>
44
- * <p>As a best practice, modify the output of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html">DescribeManagedLoginBrandingByClient</a> into the request parameters for this
45
- * operation. To get all settings, set <code>ReturnMergedResources</code> to
46
- * <code>true</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api">API and SDK operations for managed login branding</a>.</p>
47
44
  * <note>
48
45
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
49
46
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -28,9 +28,7 @@ declare const CreateUserImportJobCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates a user import job. You can import users into user pools from a comma-separated
31
- * values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill. To generate a
32
- * template for your import, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetCSVHeader.html">GetCSVHeader</a>. To learn more about CSV import, see
33
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>
31
+ * values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill.</p>
34
32
  * <note>
35
33
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
36
34
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -28,11 +28,10 @@ declare const CreateUserPoolClientCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates an app client in a user pool. This operation sets basic and advanced
31
- * configuration options. You can create an app client in the Amazon Cognito console to your
32
- * preferences and use the output of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a> to generate requests from that
33
- * baseline.</p>
34
- * <p>New app clients activate token revocation by default. For more information about
35
- * revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
31
+ * configuration options.</p>
32
+ * <p>Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a
33
+ * branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't
34
+ * available for your client until after you apply a branding style.</p>
36
35
  * <important>
37
36
  * <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
38
37
  * </important>
@@ -27,7 +27,12 @@ declare const CreateUserPoolCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <note>
30
+ * <p>Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration
31
+ * options.</p>
32
+ * <important>
33
+ * <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
34
+ * </important>
35
+ * <note>
31
36
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
32
37
  * require you to register an origination phone number before you can send SMS messages
33
38
  * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
@@ -44,13 +49,6 @@ declare const CreateUserPoolCommand_base: {
44
49
  * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
45
50
  * Developer Guide</i>.</p>
46
51
  * </note>
47
- * <p>Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration
48
- * options. You can create a user pool in the Amazon Cognito console to your preferences and use the
49
- * output of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a> to generate requests from that
50
- * baseline.</p>
51
- * <important>
52
- * <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
53
- * </important>
54
52
  * <note>
55
53
  * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
56
54
  * this operation, you must use IAM credentials to authorize requests, and you must
@@ -108,7 +106,7 @@ declare const CreateUserPoolCommand_base: {
108
106
  * PreTokenGeneration: "STRING_VALUE",
109
107
  * UserMigration: "STRING_VALUE",
110
108
  * PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
111
- * LambdaVersion: "V1_0" || "V2_0", // required
109
+ * LambdaVersion: "V1_0" || "V2_0" || "V3_0", // required
112
110
  * LambdaArn: "STRING_VALUE", // required
113
111
  * },
114
112
  * CustomSMSSender: { // CustomSMSLambdaVersionConfigType
@@ -247,7 +245,7 @@ declare const CreateUserPoolCommand_base: {
247
245
  * // PreTokenGeneration: "STRING_VALUE",
248
246
  * // UserMigration: "STRING_VALUE",
249
247
  * // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
250
- * // LambdaVersion: "V1_0" || "V2_0", // required
248
+ * // LambdaVersion: "V1_0" || "V2_0" || "V3_0", // required
251
249
  * // LambdaArn: "STRING_VALUE", // required
252
250
  * // },
253
251
  * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
@@ -28,9 +28,9 @@ declare const CreateUserPoolDomainCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>A user pool domain hosts managed login, an authorization server and web server for
31
- * authentication in your application. This operation creates a new user pool prefix or
32
- * custom domain and sets the managed login branding version. Set the branding version to
33
- * <code>1</code> for hosted UI (classic) or <code>2</code> for managed login. When you
31
+ * authentication in your application. This operation creates a new user pool prefix domain
32
+ * or custom domain and sets the managed login branding version. Set the branding version
33
+ * to <code>1</code> for hosted UI (classic) or <code>2</code> for managed login. When you
34
34
  * choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia)
35
35
  * Amazon Web Services Region in your request.</p>
36
36
  * <p>Your prefix domain might take up to one minute to take effect. Your custom domain is
@@ -27,9 +27,9 @@ declare const DeleteUserAttributesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Self-deletes attributes for a user. For example, your application can submit a request
31
- * to this operation when a user wants to remove their <code>birthdate</code> attribute
32
- * value.</p>
30
+ * <p>Deletes attributes from the currently signed-in user. For example, your application
31
+ * can submit a request to this operation when a user wants to remove their
32
+ * <code>birthdate</code> attribute value.</p>
33
33
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
34
34
  * <note>
35
35
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -27,8 +27,8 @@ declare const DeleteUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Self-deletes a user profile. A deleted user profile can no longer be used to sign in
31
- * and can't be restored.</p>
30
+ * <p>Deletes the profile of the currently signed-in user. A deleted user profile can no
31
+ * longer be used to sign in and can't be restored.</p>
32
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
33
33
  * <note>
34
34
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -29,7 +29,13 @@ declare const DeleteUserPoolCommand_base: {
29
29
  /**
30
30
  * <p>Deletes a user pool. After you delete a user pool, users can no longer sign in to any
31
31
  * associated applications. </p>
32
- * <p></p>
32
+ * <p>When you delete a user pool, it's no longer visible or operational in your Amazon Web Services account. Amazon Cognito retains deleted user pools in an inactive state for 14
33
+ * days, then begins a cleanup process that fully removes them from Amazon Web Services systems. In case
34
+ * of accidental deletion, contact Amazon Web ServicesSupport within 14 days for restoration
35
+ * assistance.</p>
36
+ * <p>Amazon Cognito begins full deletion of all resources from deleted user pools after 14 days. In
37
+ * the case of large user pools, the cleanup process might take significant additional time
38
+ * before all user data is permanently deleted.</p>
33
39
  * @example
34
40
  * Use a bare-bones client and the command you need to make an API call.
35
41
  * ```javascript
@@ -27,7 +27,7 @@ declare const DeleteWebAuthnCredentialCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a registered passkey, or webauthN, authenticator for the currently signed-in
30
+ * <p>Deletes a registered passkey, or WebAuthn, authenticator for the currently signed-in
31
31
  * user.</p>
32
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
33
33
  * <note>
@@ -94,7 +94,7 @@ declare const DescribeUserPoolCommand_base: {
94
94
  * // PreTokenGeneration: "STRING_VALUE",
95
95
  * // UserMigration: "STRING_VALUE",
96
96
  * // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
97
- * // LambdaVersion: "V1_0" || "V2_0", // required
97
+ * // LambdaVersion: "V1_0" || "V2_0" || "V3_0", // required
98
98
  * // LambdaArn: "STRING_VALUE", // required
99
99
  * // },
100
100
  * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
@@ -27,8 +27,8 @@ declare const ForgetDeviceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Forgets the specified device. For more information about device authentication, see
31
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
30
+ * <p>Given a device key, deletes a remembered device as the currently signed-in user. For
31
+ * more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
32
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
33
33
  * <note>
34
34
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -27,18 +27,13 @@ declare const ForgotPasswordCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Calling this API causes a message to be sent to the end user with a confirmation code
31
- * that is required to change the user's password. For the <code>Username</code> parameter,
32
- * you can use the username or user alias. The method used to send the confirmation code is
33
- * sent according to the specified AccountRecoverySetting. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering
34
- * User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. To
35
- * use the confirmation code for resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
36
- * <p>If neither a verified phone number nor a verified email exists, this API returns
37
- * <code>InvalidParameterException</code>. If your app client has a client secret and
38
- * you don't provide a <code>SECRET_HASH</code> parameter, this API returns
30
+ * <p>Sends a password-reset confirmation code for the currently signed-in user.</p>
31
+ * <p>For the <code>Username</code> parameter, you can use the username or user
32
+ * alias.</p>
33
+ * <p>If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an
34
+ * <code>InvalidParameterException</code> error . If your app client has a client
35
+ * secret and you don't provide a <code>SECRET_HASH</code> parameter, this API returns
39
36
  * <code>NotAuthorizedException</code>.</p>
40
- * <p>To use this API operation, your user pool must have self-service account recovery
41
- * configured. Use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html">AdminSetUserPassword</a> if you manage passwords as an administrator.</p>
42
37
  * <note>
43
38
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
44
39
  * this operation, you can't use IAM credentials to authorize requests, and you can't
@@ -27,8 +27,32 @@ declare const GetCSVHeaderCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the header information for the comma-separated value (CSV) file to be used as
31
- * input for the user import job.</p>
30
+ * <p>Given a user pool ID, generates a comma-separated value (CSV) list populated with
31
+ * available user attributes in the user pool. This list is the header for the CSV file
32
+ * that determines the users in a user import job. Save the content of
33
+ * <code>CSVHeader</code> in the response as a <code>.csv</code> file and populate it
34
+ * with the usernames and attributes of users that you want to import. For more information
35
+ * about CSV user import, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>
36
+ * <note>
37
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
38
+ * this operation, you must use IAM credentials to authorize requests, and you must
39
+ * grant yourself the corresponding IAM permission in a policy.</p>
40
+ * <p class="title">
41
+ * <b>Learn more</b>
42
+ * </p>
43
+ * <ul>
44
+ * <li>
45
+ * <p>
46
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
47
+ * </p>
48
+ * </li>
49
+ * <li>
50
+ * <p>
51
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
52
+ * </p>
53
+ * </li>
54
+ * </ul>
55
+ * </note>
32
56
  * @example
33
57
  * Use a bare-bones client and the command you need to make an API call.
34
58
  * ```javascript
@@ -27,7 +27,8 @@ declare const GetDeviceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the device. For more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
30
+ * <p>Given a device key, returns information about a remembered device for the current
31
+ * user. For more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
31
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
32
33
  * <note>
33
34
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -27,8 +27,29 @@ declare const GetGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets a group.</p>
31
- * <p>Calling this action requires developer credentials.</p>
30
+ * <p>Given a user pool ID and a group name, returns information about the user
31
+ * group.</p>
32
+ * <p> For more information about user pool groups, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html">Adding groups to a user pool</a>.</p>
33
+ * <note>
34
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
35
+ * this operation, you must use IAM credentials to authorize requests, and you must
36
+ * grant yourself the corresponding IAM permission in a policy.</p>
37
+ * <p class="title">
38
+ * <b>Learn more</b>
39
+ * </p>
40
+ * <ul>
41
+ * <li>
42
+ * <p>
43
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
44
+ * </p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
49
+ * </p>
50
+ * </li>
51
+ * </ul>
52
+ * </note>
32
53
  * @example
33
54
  * Use a bare-bones client and the command you need to make an API call.
34
55
  * ```javascript
@@ -27,7 +27,9 @@ declare const GetIdentityProviderByIdentifierCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the specified IdP.</p>
30
+ * <p>Given the identifier of an identity provider (IdP), for example
31
+ * <code>examplecorp</code>, returns information about the user pool configuration for
32
+ * that IdP. For more information about IdPs, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Third-party IdP sign-in</a>.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -27,7 +27,28 @@ declare const GetLogDeliveryConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the logging configuration of a user pool.</p>
30
+ * <p>Given a user pool ID, returns the logging configuration. User pools can export
31
+ * message-delivery error and threat-protection activity logs to external Amazon Web Services services. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html">Exporting user pool logs</a>.</p>
32
+ * <note>
33
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
34
+ * this operation, you must use IAM credentials to authorize requests, and you must
35
+ * grant yourself the corresponding IAM permission in a policy.</p>
36
+ * <p class="title">
37
+ * <b>Learn more</b>
38
+ * </p>
39
+ * <ul>
40
+ * <li>
41
+ * <p>
42
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
43
+ * </p>
44
+ * </li>
45
+ * <li>
46
+ * <p>
47
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
48
+ * </p>
49
+ * </li>
50
+ * </ul>
51
+ * </note>
31
52
  * @example
32
53
  * Use a bare-bones client and the command you need to make an API call.
33
54
  * ```javascript
@@ -27,11 +27,32 @@ declare const GetSigningCertificateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This method takes a user pool ID, and returns the signing certificate. The issued
31
- * certificate is valid for 10 years from the date of issue.</p>
32
- * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a
33
- * new value in the response to <code>GetSigningCertificate</code>, but doesn't invalidate
34
- * the original certificate.</p>
30
+ * <p>Given a user pool ID, returns the signing certificate for SAML 2.0 federation.</p>
31
+ * <p>Issued certificates are valid for 10 years from the date of issue. Amazon Cognito issues and
32
+ * assigns a new signing certificate annually. This renewal process returns a new value in
33
+ * the response to <code>GetSigningCertificate</code>, but doesn't invalidate the original
34
+ * certificate.</p>
35
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html#cognito-user-pools-SAML-signing">Signing SAML requests</a>.</p>
36
+ * <note>
37
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
38
+ * this operation, you must use IAM credentials to authorize requests, and you must
39
+ * grant yourself the corresponding IAM permission in a policy.</p>
40
+ * <p class="title">
41
+ * <b>Learn more</b>
42
+ * </p>
43
+ * <ul>
44
+ * <li>
45
+ * <p>
46
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
47
+ * </p>
48
+ * </li>
49
+ * <li>
50
+ * <p>
51
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
52
+ * </p>
53
+ * </li>
54
+ * </ul>
55
+ * </note>
35
56
  * @example
36
57
  * Use a bare-bones client and the command you need to make an API call.
37
58
  * ```javascript
@@ -27,11 +27,11 @@ declare const GetUICustomizationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the user interface (UI) Customization information for a particular app client's
31
- * app UI, if any such information exists for the client. If nothing is set for the
32
- * particular client, but there is an existing pool level customization (the app
33
- * <code>clientId</code> is <code>ALL</code>), then that information is returned. If
34
- * nothing is present, then an empty shape is returned.</p>
30
+ * <p>Given a user pool ID or app client, returns information about classic hosted UI
31
+ * branding that you applied, if any. Returns user-pool level branding information if no
32
+ * app client branding is applied, or if you don't specify an app client ID. Returns
33
+ * an empty object if you haven't applied hosted UI branding to either the client or
34
+ * the user pool. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html">Hosted UI (classic) branding</a>.</p>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
37
37
  * ```javascript
@@ -27,9 +27,8 @@ declare const GetUserAttributeVerificationCodeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Generates a user attribute verification code for the specified attribute name. Sends a
31
- * message to a user with a code that they must return in a VerifyUserAttribute
32
- * request.</p>
30
+ * <p>Given an attribute name, sends a user attribute verification code for the specified
31
+ * attribute name to the currently signed-in user.</p>
33
32
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
34
33
  * <note>
35
34
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
@@ -34,11 +34,17 @@ declare const GetUserAuthFactorsCommand_base: {
34
34
  * <p>The user's multi-factor authentication (MFA) preferences.</p>
35
35
  * </li>
36
36
  * <li>
37
- * <p>The user's options in the <code>USER_AUTH</code> flow that they can
38
- * select in a <code>SELECT_CHALLENGE</code> response or request in a
39
- * <code>PREFERRED_CHALLENGE</code>request.</p>
37
+ * <p>The user's options for choice-based authentication with the
38
+ * <code>USER_AUTH</code> flow.</p>
40
39
  * </li>
41
40
  * </ol>
41
+ * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
42
+ * <note>
43
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
44
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
45
+ * grant IAM permissions in policies. For more information about authorization models in
46
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
47
+ * </note>
42
48
  * @example
43
49
  * Use a bare-bones client and the command you need to make an API call.
44
50
  * ```javascript
@@ -27,7 +27,7 @@ declare const GetUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the user attributes and metadata for a user.</p>
30
+ * <p>Gets user attributes and and MFA settings for the currently signed-in user.</p>
31
31
  * <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
32
32
  * <note>
33
33
  * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For