@aws-sdk/client-cognito-identity-provider 3.379.1 → 3.383.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 (128) hide show
  1. package/README.md +83 -6
  2. package/dist-cjs/CognitoIdentityProvider.js +4 -0
  3. package/dist-cjs/commands/GetLogDeliveryConfigurationCommand.js +48 -0
  4. package/dist-cjs/commands/SetLogDeliveryConfigurationCommand.js +48 -0
  5. package/dist-cjs/commands/SetRiskConfigurationCommand.js +2 -1
  6. package/dist-cjs/commands/SetUICustomizationCommand.js +3 -3
  7. package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +2 -2
  8. package/dist-cjs/commands/SetUserSettingsCommand.js +2 -2
  9. package/dist-cjs/commands/VerifySoftwareTokenCommand.js +1 -1
  10. package/dist-cjs/commands/index.js +2 -0
  11. package/dist-cjs/models/models_0.js +9 -48
  12. package/dist-cjs/models/models_1.js +26 -9
  13. package/dist-cjs/protocols/Aws_json1_1.js +108 -4
  14. package/dist-es/CognitoIdentityProvider.js +4 -0
  15. package/dist-es/commands/GetLogDeliveryConfigurationCommand.js +44 -0
  16. package/dist-es/commands/SetLogDeliveryConfigurationCommand.js +44 -0
  17. package/dist-es/commands/SetRiskConfigurationCommand.js +2 -1
  18. package/dist-es/commands/SetUICustomizationCommand.js +1 -1
  19. package/dist-es/commands/SetUserMFAPreferenceCommand.js +1 -1
  20. package/dist-es/commands/SetUserSettingsCommand.js +1 -1
  21. package/dist-es/commands/VerifySoftwareTokenCommand.js +2 -2
  22. package/dist-es/commands/index.js +2 -0
  23. package/dist-es/models/models_0.js +6 -39
  24. package/dist-es/models/models_1.js +21 -8
  25. package/dist-es/protocols/Aws_json1_1.js +100 -0
  26. package/dist-types/CognitoIdentityProvider.d.ts +81 -6
  27. package/dist-types/CognitoIdentityProviderClient.d.ts +71 -8
  28. package/dist-types/commands/AddCustomAttributesCommand.d.ts +20 -0
  29. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +20 -1
  30. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +20 -1
  31. package/dist-types/commands/AdminCreateUserCommand.d.ts +22 -4
  32. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +20 -1
  33. package/dist-types/commands/AdminDeleteUserCommand.d.ts +20 -1
  34. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +22 -4
  35. package/dist-types/commands/AdminDisableUserCommand.d.ts +23 -3
  36. package/dist-types/commands/AdminEnableUserCommand.d.ts +20 -1
  37. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +20 -1
  38. package/dist-types/commands/AdminGetDeviceCommand.d.ts +20 -1
  39. package/dist-types/commands/AdminGetUserCommand.d.ts +20 -1
  40. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +22 -3
  41. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +22 -3
  42. package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -1
  43. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +20 -1
  44. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +20 -0
  45. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +20 -1
  46. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +30 -11
  47. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +24 -5
  48. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +20 -0
  49. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +31 -0
  50. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +20 -0
  51. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +20 -0
  52. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +20 -1
  53. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +31 -12
  54. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +28 -7
  55. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +8 -1
  56. package/dist-types/commands/ChangePasswordCommand.d.ts +8 -1
  57. package/dist-types/commands/ConfirmDeviceCommand.d.ts +8 -1
  58. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +8 -1
  59. package/dist-types/commands/ConfirmSignUpCommand.d.ts +10 -3
  60. package/dist-types/commands/CreateGroupCommand.d.ts +20 -1
  61. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +20 -0
  62. package/dist-types/commands/CreateResourceServerCommand.d.ts +20 -0
  63. package/dist-types/commands/CreateUserImportJobCommand.d.ts +21 -1
  64. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +23 -0
  65. package/dist-types/commands/CreateUserPoolCommand.d.ts +28 -5
  66. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +20 -0
  67. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +8 -1
  68. package/dist-types/commands/DeleteUserCommand.d.ts +9 -2
  69. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +20 -0
  70. package/dist-types/commands/DescribeUserPoolCommand.d.ts +20 -0
  71. package/dist-types/commands/ForgetDeviceCommand.d.ts +8 -1
  72. package/dist-types/commands/ForgotPasswordCommand.d.ts +16 -7
  73. package/dist-types/commands/GetDeviceCommand.d.ts +8 -1
  74. package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +102 -0
  75. package/dist-types/commands/GetSigningCertificateCommand.d.ts +5 -3
  76. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -3
  77. package/dist-types/commands/GetUserCommand.d.ts +8 -1
  78. package/dist-types/commands/GlobalSignOutCommand.d.ts +16 -4
  79. package/dist-types/commands/InitiateAuthCommand.d.ts +10 -3
  80. package/dist-types/commands/ListDevicesCommand.d.ts +8 -1
  81. package/dist-types/commands/ListGroupsCommand.d.ts +20 -1
  82. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +20 -0
  83. package/dist-types/commands/ListResourceServersCommand.d.ts +20 -0
  84. package/dist-types/commands/ListUserImportJobsCommand.d.ts +21 -1
  85. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +20 -0
  86. package/dist-types/commands/ListUserPoolsCommand.d.ts +20 -0
  87. package/dist-types/commands/ListUsersCommand.d.ts +21 -1
  88. package/dist-types/commands/ListUsersInGroupCommand.d.ts +20 -1
  89. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -3
  90. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +12 -5
  91. package/dist-types/commands/RevokeTokenCommand.d.ts +10 -3
  92. package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +111 -0
  93. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +2 -1
  94. package/dist-types/commands/SetUICustomizationCommand.d.ts +1 -1
  95. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +9 -2
  96. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +3 -3
  97. package/dist-types/commands/SetUserSettingsCommand.d.ts +9 -2
  98. package/dist-types/commands/SignUpCommand.d.ts +10 -3
  99. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +6 -0
  100. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +8 -1
  101. package/dist-types/commands/UpdateGroupCommand.d.ts +20 -1
  102. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +20 -0
  103. package/dist-types/commands/UpdateResourceServerCommand.d.ts +20 -0
  104. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -5
  105. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +21 -2
  106. package/dist-types/commands/UpdateUserPoolCommand.d.ts +28 -7
  107. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +20 -0
  108. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +8 -1
  109. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +13 -9
  110. package/dist-types/commands/index.d.ts +2 -0
  111. package/dist-types/index.d.ts +67 -6
  112. package/dist-types/models/models_0.d.ts +1045 -304
  113. package/dist-types/models/models_1.d.ts +348 -18
  114. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  115. package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +34 -0
  116. package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +12 -0
  117. package/dist-types/ts3.4/commands/GetLogDeliveryConfigurationCommand.d.ts +42 -0
  118. package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +42 -0
  119. package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +2 -4
  120. package/dist-types/ts3.4/commands/SetUICustomizationCommand.d.ts +1 -1
  121. package/dist-types/ts3.4/commands/SetUserMFAPreferenceCommand.d.ts +1 -1
  122. package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +1 -1
  123. package/dist-types/ts3.4/commands/SetUserSettingsCommand.d.ts +1 -1
  124. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  125. package/dist-types/ts3.4/models/models_0.d.ts +34 -52
  126. package/dist-types/ts3.4/models/models_1.d.ts +56 -3
  127. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  128. package/package.json +5 -5
@@ -23,9 +23,29 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in,
27
- * but still appears in the responses to <code>GetUser</code> and <code>ListUsers</code> API requests.</p>
28
- * <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
26
+ * <p>Deactivates a user and revokes all access tokens for the user. A deactivated user
27
+ * can't sign in, but still appears in the responses to <code>GetUser</code> and
28
+ * <code>ListUsers</code> API requests.</p>
29
+ * <note>
30
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
31
+ * this operation, you must use IAM credentials to authorize requests, and you must
32
+ * grant yourself the corresponding IAM permission in a policy.</p>
33
+ * <p class="title">
34
+ * <b>Learn more</b>
35
+ * </p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
40
+ * </p>
41
+ * </li>
42
+ * <li>
43
+ * <p>
44
+ * <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>
45
+ * </p>
46
+ * </li>
47
+ * </ul>
48
+ * </note>
29
49
  * @example
30
50
  * Use a bare-bones client and the command you need to make an API call.
31
51
  * ```javascript
@@ -24,7 +24,26 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
24
24
  /**
25
25
  * @public
26
26
  * <p>Enables the specified user as an administrator. Works on any user.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript
@@ -24,7 +24,26 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {
24
24
  /**
25
25
  * @public
26
26
  * <p>Forgets the device, as an administrator.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript
@@ -24,7 +24,26 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets the device, as an administrator.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript
@@ -25,7 +25,26 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
25
25
  * @public
26
26
  * <p>Gets the specified user by user name in a user pool as an administrator. Works on any
27
27
  * user.</p>
28
- * <p>Calling this action requires developer credentials.</p>
28
+ * <note>
29
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
30
+ * this operation, you must use IAM credentials to authorize requests, and you must
31
+ * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * <p class="title">
33
+ * <b>Learn more</b>
34
+ * </p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
39
+ * </p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <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>
44
+ * </p>
45
+ * </li>
46
+ * </ul>
47
+ * </note>
29
48
  * @example
30
49
  * Use a bare-bones client and the command you need to make an API call.
31
50
  * ```javascript
@@ -38,10 +38,29 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
38
38
  * mode</a>
39
39
  * </i>, you can send messages only to verified phone
40
40
  * numbers. After you test your app while in the sandbox environment, you can move out
41
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
41
+ * 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
42
42
  * Developer Guide</i>.</p>
43
43
  * </note>
44
- * <p>Calling this action requires developer credentials.</p>
44
+ * <note>
45
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
46
+ * this operation, you must use IAM credentials to authorize requests, and you must
47
+ * grant yourself the corresponding IAM permission in a policy.</p>
48
+ * <p class="title">
49
+ * <b>Learn more</b>
50
+ * </p>
51
+ * <ul>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
55
+ * </p>
56
+ * </li>
57
+ * <li>
58
+ * <p>
59
+ * <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>
60
+ * </p>
61
+ * </li>
62
+ * </ul>
63
+ * </note>
45
64
  * @example
46
65
  * Use a bare-bones client and the command you need to make an API call.
47
66
  * ```javascript
@@ -120,7 +139,7 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
120
139
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
121
140
  * <p>This exception is thrown when the trust relationship is not valid for the role
122
141
  * provided for SMS configuration. This can happen if you don't trust
123
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
142
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
124
143
  * not match what is provided in the SMS configuration for the user pool.</p>
125
144
  *
126
145
  * @throws {@link InvalidUserPoolConfigurationException} (client fault)
@@ -40,7 +40,26 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
40
40
  * an existing user in the user pool, it is critical that it only be used with external
41
41
  * IdPs and provider attributes that have been trusted by the application owner.</p>
42
42
  * </important>
43
- * <p>This action is administrative and requires developer credentials.</p>
43
+ * <note>
44
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
45
+ * this operation, you must use IAM credentials to authorize requests, and you must
46
+ * grant yourself the corresponding IAM permission in a policy.</p>
47
+ * <p class="title">
48
+ * <b>Learn more</b>
49
+ * </p>
50
+ * <ul>
51
+ * <li>
52
+ * <p>
53
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
54
+ * </p>
55
+ * </li>
56
+ * <li>
57
+ * <p>
58
+ * <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>
59
+ * </p>
60
+ * </li>
61
+ * </ul>
62
+ * </note>
44
63
  * @example
45
64
  * Use a bare-bones client and the command you need to make an API call.
46
65
  * ```javascript
@@ -74,8 +93,8 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
74
93
  *
75
94
  * @throws {@link AliasExistsException} (client fault)
76
95
  * <p>This exception is thrown when a user tries to confirm the account with an email
77
- * address or phone number that has already been supplied as an alias for a different
78
- * user profile. This exception indicates that an account with this email address or phone
96
+ * address or phone number that has already been supplied as an alias for a different user
97
+ * profile. This exception indicates that an account with this email address or phone
79
98
  * already exists in a user pool that you've configured to use email address or phone
80
99
  * number as a sign-in alias.</p>
81
100
  *
@@ -24,7 +24,26 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists devices, as an administrator.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript
@@ -24,7 +24,26 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the groups that the user belongs to.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript
@@ -25,6 +25,26 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
25
25
  * @public
26
26
  * <p>A history of user activity and any risks detected as part of Amazon Cognito advanced
27
27
  * security.</p>
28
+ * <note>
29
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
30
+ * this operation, you must use IAM credentials to authorize requests, and you must
31
+ * grant yourself the corresponding IAM permission in a policy.</p>
32
+ * <p class="title">
33
+ * <b>Learn more</b>
34
+ * </p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
39
+ * </p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <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>
44
+ * </p>
45
+ * </li>
46
+ * </ul>
47
+ * </note>
28
48
  * @example
29
49
  * Use a bare-bones client and the command you need to make an API call.
30
50
  * ```javascript
@@ -24,7 +24,26 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
24
24
  /**
25
25
  * @public
26
26
  * <p>Removes the specified user from the specified group.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript
@@ -25,14 +25,6 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
25
25
  * @public
26
26
  * <p>Resets the specified user's password in a user pool as an administrator. Works on any
27
27
  * user.</p>
28
- * <p>When a developer calls this API, the current password is invalidated, so it must be
29
- * changed. If a user tries to sign in after the API is called, the app will get a
30
- * PasswordResetRequiredException exception back and should direct the user down the flow
31
- * to reset the password, which is the same as the forgot password flow. In addition, if
32
- * the user pool has phone verification selected and a verified phone number exists for the
33
- * user, or if email verification is selected and a verified email exists for the user,
34
- * calling this API will also result in sending a message to the end user with the code to
35
- * change their password.</p>
36
28
  * <note>
37
29
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
38
30
  * require you to register an origination phone number before you can send SMS messages
@@ -47,10 +39,37 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
47
39
  * mode</a>
48
40
  * </i>, you can send messages only to verified phone
49
41
  * numbers. After you test your app while in the sandbox environment, you can move out
50
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
42
+ * 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
51
43
  * Developer Guide</i>.</p>
52
44
  * </note>
53
- * <p>Calling this action requires developer credentials.</p>
45
+ * <p>Deactivates a user's password, requiring them to change it. If a user tries to sign in
46
+ * after the API is called, Amazon Cognito responds with a
47
+ * <code>PasswordResetRequiredException</code> error. Your app must then perform the
48
+ * actions that reset your user's password: the forgot-password flow. In addition, if the
49
+ * user pool has phone verification selected and a verified phone number exists for the
50
+ * user, or if email verification is selected and a verified email exists for the user,
51
+ * calling this API will also result in sending a message to the end user with the code to
52
+ * change their password.</p>
53
+ * <note>
54
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
55
+ * this operation, you must use IAM credentials to authorize requests, and you must
56
+ * grant yourself the corresponding IAM permission in a policy.</p>
57
+ * <p class="title">
58
+ * <b>Learn more</b>
59
+ * </p>
60
+ * <ul>
61
+ * <li>
62
+ * <p>
63
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
64
+ * </p>
65
+ * </li>
66
+ * <li>
67
+ * <p>
68
+ * <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>
69
+ * </p>
70
+ * </li>
71
+ * </ul>
72
+ * </note>
54
73
  * @example
55
74
  * Use a bare-bones client and the command you need to make an API call.
56
75
  * ```javascript
@@ -97,7 +116,7 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
97
116
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
98
117
  * <p>This exception is thrown when the trust relationship is not valid for the role
99
118
  * provided for SMS configuration. This can happen if you don't trust
100
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
119
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
101
120
  * not match what is provided in the SMS configuration for the user pool.</p>
102
121
  *
103
122
  * @throws {@link LimitExceededException} (client fault)
@@ -38,10 +38,29 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
38
38
  * mode</a>
39
39
  * </i>, you can send messages only to verified phone
40
40
  * numbers. After you test your app while in the sandbox environment, you can move out
41
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
41
+ * 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
42
42
  * Developer Guide</i>.</p>
43
43
  * </note>
44
- * <p>Calling this action requires developer credentials.</p>
44
+ * <note>
45
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
46
+ * this operation, you must use IAM credentials to authorize requests, and you must
47
+ * grant yourself the corresponding IAM permission in a policy.</p>
48
+ * <p class="title">
49
+ * <b>Learn more</b>
50
+ * </p>
51
+ * <ul>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
55
+ * </p>
56
+ * </li>
57
+ * <li>
58
+ * <p>
59
+ * <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>
60
+ * </p>
61
+ * </li>
62
+ * </ul>
63
+ * </note>
45
64
  * @example
46
65
  * Use a bare-bones client and the command you need to make an API call.
47
66
  * ```javascript
@@ -106,8 +125,8 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
106
125
  *
107
126
  * @throws {@link AliasExistsException} (client fault)
108
127
  * <p>This exception is thrown when a user tries to confirm the account with an email
109
- * address or phone number that has already been supplied as an alias for a different
110
- * user profile. This exception indicates that an account with this email address or phone
128
+ * address or phone number that has already been supplied as an alias for a different user
129
+ * profile. This exception indicates that an account with this email address or phone
111
130
  * already exists in a user pool that you've configured to use email address or phone
112
131
  * number as a sign-in alias.</p>
113
132
  *
@@ -138,7 +157,7 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
138
157
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
139
158
  * <p>This exception is thrown when the trust relationship is not valid for the role
140
159
  * provided for SMS configuration. This can happen if you don't trust
141
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
160
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
142
161
  * not match what is provided in the SMS configuration for the user pool.</p>
143
162
  *
144
163
  * @throws {@link InvalidUserPoolConfigurationException} (client fault)
@@ -28,6 +28,26 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
28
28
  * preferred MFA factor will be used to authenticate a user if multiple factors are
29
29
  * activated. If multiple options are activated and no preference is set, a challenge to
30
30
  * choose an MFA option will be returned during sign-in.</p>
31
+ * <note>
32
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
33
+ * this operation, you must use IAM credentials to authorize requests, and you must
34
+ * grant yourself the corresponding IAM permission in a policy.</p>
35
+ * <p class="title">
36
+ * <b>Learn more</b>
37
+ * </p>
38
+ * <ul>
39
+ * <li>
40
+ * <p>
41
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
42
+ * </p>
43
+ * </li>
44
+ * <li>
45
+ * <p>
46
+ * <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>
47
+ * </p>
48
+ * </li>
49
+ * </ul>
50
+ * </note>
31
51
  * @example
32
52
  * Use a bare-bones client and the command you need to make an API call.
33
53
  * ```javascript
@@ -33,6 +33,37 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
33
33
  * password. </p>
34
34
  * <p>Once the user has set a new password, or the password is permanent, the user status is
35
35
  * set to <code>Confirmed</code>.</p>
36
+ * <p>
37
+ * <code>AdminSetUserPassword</code> can set a password for the user profile that Amazon Cognito
38
+ * creates for third-party federated users. When you set a password, the federated user's
39
+ * status changes from <code>EXTERNAL_PROVIDER</code> to <code>CONFIRMED</code>. A user in
40
+ * this state can sign in as a federated user, and initiate authentication flows in the API
41
+ * like a linked native user. They can also modify their password and attributes in
42
+ * token-authenticated API requests like <code>ChangePassword</code> and
43
+ * <code>UpdateUserAttributes</code>. As a best security practice and to keep users in
44
+ * sync with your external IdP, don't set passwords on federated user profiles. To set up a
45
+ * federated user for native sign-in with a linked native user, refer to <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">Linking federated users to an existing user
46
+ * profile</a>.</p>
47
+ * <note>
48
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
49
+ * this operation, you must use IAM credentials to authorize requests, and you must
50
+ * grant yourself the corresponding IAM permission in a policy.</p>
51
+ * <p class="title">
52
+ * <b>Learn more</b>
53
+ * </p>
54
+ * <ul>
55
+ * <li>
56
+ * <p>
57
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
58
+ * </p>
59
+ * </li>
60
+ * <li>
61
+ * <p>
62
+ * <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>
63
+ * </p>
64
+ * </li>
65
+ * </ul>
66
+ * </note>
36
67
  * @example
37
68
  * Use a bare-bones client and the command you need to make an API call.
38
69
  * ```javascript
@@ -27,6 +27,26 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
27
27
  * <i>This action is no longer supported.</i> You can use it to configure
28
28
  * only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
29
29
  * token MFA. To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
30
+ * <note>
31
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
32
+ * this operation, you must use IAM credentials to authorize requests, and you must
33
+ * grant yourself the corresponding IAM permission in a policy.</p>
34
+ * <p class="title">
35
+ * <b>Learn more</b>
36
+ * </p>
37
+ * <ul>
38
+ * <li>
39
+ * <p>
40
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
41
+ * </p>
42
+ * </li>
43
+ * <li>
44
+ * <p>
45
+ * <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>
46
+ * </p>
47
+ * </li>
48
+ * </ul>
49
+ * </note>
30
50
  * @example
31
51
  * Use a bare-bones client and the command you need to make an API call.
32
52
  * ```javascript
@@ -26,6 +26,26 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
26
26
  * <p>Provides feedback for an authentication event indicating if it was from a valid user.
27
27
  * This feedback is used for improving the risk evaluation decision for the user pool as
28
28
  * part of Amazon Cognito advanced security.</p>
29
+ * <note>
30
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
31
+ * this operation, you must use IAM credentials to authorize requests, and you must
32
+ * grant yourself the corresponding IAM permission in a policy.</p>
33
+ * <p class="title">
34
+ * <b>Learn more</b>
35
+ * </p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
40
+ * </p>
41
+ * </li>
42
+ * <li>
43
+ * <p>
44
+ * <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>
45
+ * </p>
46
+ * </li>
47
+ * </ul>
48
+ * </note>
29
49
  * @example
30
50
  * Use a bare-bones client and the command you need to make an API call.
31
51
  * ```javascript
@@ -24,7 +24,26 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
24
24
  /**
25
25
  * @public
26
26
  * <p>Updates the device status as an administrator.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you must use IAM credentials to authorize requests, and you must
30
+ * grant yourself the corresponding IAM permission in a policy.</p>
31
+ * <p class="title">
32
+ * <b>Learn more</b>
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>
37
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
38
+ * </p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <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>
43
+ * </p>
44
+ * </li>
45
+ * </ul>
46
+ * </note>
28
47
  * @example
29
48
  * Use a bare-bones client and the command you need to make an API call.
30
49
  * ```javascript