@aws-sdk/client-cognito-identity-provider 3.382.0 → 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 +371 -319
  113. package/dist-types/models/models_1.d.ts +242 -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 +1 -1
@@ -23,13 +23,7 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Updates the specified user's attributes, including developer attributes, as an
27
- * administrator. Works on any user.</p>
28
- * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
29
- * attribute name.</p>
30
- * <p>In addition to updating user attributes, this API can also be used to mark phone and
31
- * email as verified.</p>
32
- * <note>
26
+ * <note>
33
27
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
34
28
  * require you to register an origination phone number before you can send SMS messages
35
29
  * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
@@ -43,10 +37,35 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
43
37
  * mode</a>
44
38
  * </i>, you can send messages only to verified phone
45
39
  * numbers. After you test your app while in the sandbox environment, you can move out
46
- * 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
40
+ * 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
47
41
  * Developer Guide</i>.</p>
48
42
  * </note>
49
- * <p>Calling this action requires developer credentials.</p>
43
+ * <p>Updates the specified user's attributes, including developer attributes, as an
44
+ * administrator. Works on any user.</p>
45
+ * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
46
+ * attribute name.</p>
47
+ * <p>In addition to updating user attributes, this API can also be used to mark phone and
48
+ * email as verified.</p>
49
+ * <note>
50
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
51
+ * this operation, you must use IAM credentials to authorize requests, and you must
52
+ * grant yourself the corresponding IAM permission in a policy.</p>
53
+ * <p class="title">
54
+ * <b>Learn more</b>
55
+ * </p>
56
+ * <ul>
57
+ * <li>
58
+ * <p>
59
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
60
+ * </p>
61
+ * </li>
62
+ * <li>
63
+ * <p>
64
+ * <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>
65
+ * </p>
66
+ * </li>
67
+ * </ul>
68
+ * </note>
50
69
  * @example
51
70
  * Use a bare-bones client and the command you need to make an API call.
52
71
  * ```javascript
@@ -80,8 +99,8 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
80
99
  *
81
100
  * @throws {@link AliasExistsException} (client fault)
82
101
  * <p>This exception is thrown when a user tries to confirm the account with an email
83
- * address or phone number that has already been supplied as an alias for a different
84
- * user profile. This exception indicates that an account with this email address or phone
102
+ * address or phone number that has already been supplied as an alias for a different user
103
+ * profile. This exception indicates that an account with this email address or phone
85
104
  * already exists in a user pool that you've configured to use email address or phone
86
105
  * number as a sign-in alias.</p>
87
106
  *
@@ -106,7 +125,7 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
106
125
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
107
126
  * <p>This exception is thrown when the trust relationship is not valid for the role
108
127
  * provided for SMS configuration. This can happen if you don't trust
109
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
128
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
110
129
  * not match what is provided in the SMS configuration for the user pool.</p>
111
130
  *
112
131
  * @throws {@link NotAuthorizedException} (client fault)
@@ -23,13 +23,34 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests
27
- * with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to
28
- * a user. The user's current access and ID tokens remain valid until they expire. By
29
- * default, access and ID tokens expire one hour after they're issued. A user can still use
30
- * a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period
31
- * of 1 hour.</p>
32
- * <p>Calling this action requires developer credentials.</p>
26
+ * <p>Signs out a user from all devices. <code>AdminUserGlobalSignOut</code> invalidates all
27
+ * identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still
28
+ * use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie
29
+ * validity period.</p>
30
+ * <p>Your app isn't aware that a user's access token is revoked unless it attempts to
31
+ * authorize a user pools API request with an access token that contains the scope
32
+ * <code>aws.cognito.signin.user.admin</code>. Your app might otherwise accept access
33
+ * tokens until they expire.</p>
34
+ * <note>
35
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
36
+ * this operation, you must use IAM credentials to authorize requests, and you must
37
+ * grant yourself the corresponding IAM permission in a policy.</p>
38
+ * <p class="title">
39
+ * <b>Learn more</b>
40
+ * </p>
41
+ * <ul>
42
+ * <li>
43
+ * <p>
44
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
45
+ * </p>
46
+ * </li>
47
+ * <li>
48
+ * <p>
49
+ * <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>
50
+ * </p>
51
+ * </li>
52
+ * </ul>
53
+ * </note>
33
54
  * @example
34
55
  * Use a bare-bones client and the command you need to make an API call.
35
56
  * ```javascript
@@ -40,6 +40,12 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
40
40
  * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
41
41
  * this challenge with your user's TOTP.</p>
42
42
  * </note>
43
+ * <note>
44
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
45
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
46
+ * grant IAM permissions in policies. For more information about authorization models in
47
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
48
+ * </note>
43
49
  * @example
44
50
  * Use a bare-bones client and the command you need to make an API call.
45
51
  * ```javascript
@@ -70,7 +76,8 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
70
76
  * concurrently.</p>
71
77
  *
72
78
  * @throws {@link ForbiddenException} (client fault)
73
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
79
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
80
+ * ACL that's associated with your user pool.</p>
74
81
  *
75
82
  * @throws {@link InternalErrorException} (server fault)
76
83
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -24,6 +24,12 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
24
24
  /**
25
25
  * @public
26
26
  * <p>Changes the password for a specified user in a user pool.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
30
+ * grant IAM permissions in policies. For more information about authorization models in
31
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
32
+ * </note>
27
33
  * @example
28
34
  * Use a bare-bones client and the command you need to make an API call.
29
35
  * ```javascript
@@ -48,7 +54,8 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
48
54
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
49
55
  *
50
56
  * @throws {@link ForbiddenException} (client fault)
51
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
57
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
58
+ * ACL that's associated with your user pool.</p>
52
59
  *
53
60
  * @throws {@link InternalErrorException} (server fault)
54
61
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -25,6 +25,12 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
25
25
  * @public
26
26
  * <p>Confirms tracking of the device. This API call is the call that begins device
27
27
  * tracking.</p>
28
+ * <note>
29
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
30
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
31
+ * grant IAM permissions in policies. For more information about authorization models in
32
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
33
+ * </note>
28
34
  * @example
29
35
  * Use a bare-bones client and the command you need to make an API call.
30
36
  * ```javascript
@@ -55,7 +61,8 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
55
61
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
56
62
  *
57
63
  * @throws {@link ForbiddenException} (client fault)
58
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
64
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
65
+ * ACL that's associated with your user pool.</p>
59
66
  *
60
67
  * @throws {@link InternalErrorException} (server fault)
61
68
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -24,6 +24,12 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
24
24
  /**
25
25
  * @public
26
26
  * <p>Allows a user to enter a confirmation code to reset a forgotten password.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
30
+ * grant IAM permissions in policies. For more information about authorization models in
31
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
32
+ * </note>
27
33
  * @example
28
34
  * Use a bare-bones client and the command you need to make an API call.
29
35
  * ```javascript
@@ -67,7 +73,8 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
67
73
  * <p>This exception is thrown if a code has expired.</p>
68
74
  *
69
75
  * @throws {@link ForbiddenException} (client fault)
70
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
76
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
77
+ * ACL that's associated with your user pool.</p>
71
78
  *
72
79
  * @throws {@link InternalErrorException} (server fault)
73
80
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -24,6 +24,12 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
24
24
  /**
25
25
  * @public
26
26
  * <p>Confirms registration of a new user.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
30
+ * grant IAM permissions in policies. For more information about authorization models in
31
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
32
+ * </note>
27
33
  * @example
28
34
  * Use a bare-bones client and the command you need to make an API call.
29
35
  * ```javascript
@@ -61,8 +67,8 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
61
67
  *
62
68
  * @throws {@link AliasExistsException} (client fault)
63
69
  * <p>This exception is thrown when a user tries to confirm the account with an email
64
- * address or phone number that has already been supplied as an alias for a different
65
- * user profile. This exception indicates that an account with this email address or phone
70
+ * address or phone number that has already been supplied as an alias for a different user
71
+ * profile. This exception indicates that an account with this email address or phone
66
72
  * already exists in a user pool that you've configured to use email address or phone
67
73
  * number as a sign-in alias.</p>
68
74
  *
@@ -74,7 +80,8 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
74
80
  * <p>This exception is thrown if a code has expired.</p>
75
81
  *
76
82
  * @throws {@link ForbiddenException} (client fault)
77
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
83
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
84
+ * ACL that's associated with your user pool.</p>
78
85
  *
79
86
  * @throws {@link InternalErrorException} (server fault)
80
87
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -24,7 +24,26 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates a new group in the specified user pool.</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,6 +24,26 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates an IdP for a user pool.</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>
27
47
  * @example
28
48
  * Use a bare-bones client and the command you need to make an API call.
29
49
  * ```javascript
@@ -24,6 +24,26 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</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>
27
47
  * @example
28
48
  * Use a bare-bones client and the command you need to make an API call.
29
49
  * ```javascript
@@ -23,7 +23,27 @@ export interface CreateUserImportJobCommandOutput extends CreateUserImportJobRes
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates the user import job.</p>
26
+ * <p>Creates a user import job.</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>
27
47
  * @example
28
48
  * Use a bare-bones client and the command you need to make an API call.
29
49
  * ```javascript
@@ -26,6 +26,29 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
26
26
  * <p>Creates the user pool client.</p>
27
27
  * <p>When you create a new user pool client, token revocation is automatically activated.
28
28
  * For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
29
+ * <important>
30
+ * <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
31
+ * </important>
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>
29
52
  * @example
30
53
  * Use a bare-bones client and the command you need to make an API call.
31
54
  * ```javascript
@@ -23,9 +23,7 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
27
- * pool.</p>
28
- * <note>
26
+ * <note>
29
27
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
30
28
  * require you to register an origination phone number before you can send SMS messages
31
29
  * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
@@ -39,9 +37,34 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
39
37
  * mode</a>
40
38
  * </i>, you can send messages only to verified phone
41
39
  * numbers. After you test your app while in the sandbox environment, you can move out
42
- * 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
40
+ * 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
43
41
  * Developer Guide</i>.</p>
44
42
  * </note>
43
+ * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
44
+ * pool.</p>
45
+ * <important>
46
+ * <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
47
+ * </important>
48
+ * <note>
49
+ * <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
50
+ * this operation, you must use IAM credentials to authorize requests, and you must
51
+ * grant yourself the corresponding IAM permission in a policy.</p>
52
+ * <p class="title">
53
+ * <b>Learn more</b>
54
+ * </p>
55
+ * <ul>
56
+ * <li>
57
+ * <p>
58
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
59
+ * </p>
60
+ * </li>
61
+ * <li>
62
+ * <p>
63
+ * <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>
64
+ * </p>
65
+ * </li>
66
+ * </ul>
67
+ * </note>
45
68
  * @example
46
69
  * Use a bare-bones client and the command you need to make an API call.
47
70
  * ```javascript
@@ -331,7 +354,7 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
331
354
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
332
355
  * <p>This exception is thrown when the trust relationship is not valid for the role
333
356
  * provided for SMS configuration. This can happen if you don't trust
334
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
357
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
335
358
  * not match what is provided in the SMS configuration for the user pool.</p>
336
359
  *
337
360
  * @throws {@link LimitExceededException} (client fault)
@@ -24,6 +24,26 @@ export interface CreateUserPoolDomainCommandOutput extends CreateUserPoolDomainR
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates a new domain for a user pool.</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>
27
47
  * @example
28
48
  * Use a bare-bones client and the command you need to make an API call.
29
49
  * ```javascript
@@ -24,6 +24,12 @@ export interface DeleteUserAttributesCommandOutput extends DeleteUserAttributesR
24
24
  /**
25
25
  * @public
26
26
  * <p>Deletes the attributes for a user.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
30
+ * grant IAM permissions in policies. For more information about authorization models in
31
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
32
+ * </note>
27
33
  * @example
28
34
  * Use a bare-bones client and the command you need to make an API call.
29
35
  * ```javascript
@@ -49,7 +55,8 @@ export interface DeleteUserAttributesCommandOutput extends DeleteUserAttributesR
49
55
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
50
56
  *
51
57
  * @throws {@link ForbiddenException} (client fault)
52
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
58
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
59
+ * ACL that's associated with your user pool.</p>
53
60
  *
54
61
  * @throws {@link InternalErrorException} (server fault)
55
62
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -23,7 +23,13 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Allows a user to delete himself or herself.</p>
26
+ * <p>Allows a user to delete their own user profile.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
30
+ * grant IAM permissions in policies. For more information about authorization models in
31
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
32
+ * </note>
27
33
  * @example
28
34
  * Use a bare-bones client and the command you need to make an API call.
29
35
  * ```javascript
@@ -46,7 +52,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
46
52
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
47
53
  *
48
54
  * @throws {@link ForbiddenException} (client fault)
49
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
55
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
56
+ * ACL that's associated with your user pool.</p>
50
57
  *
51
58
  * @throws {@link InternalErrorException} (server fault)
52
59
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -25,6 +25,26 @@ export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolCli
25
25
  * @public
26
26
  * <p>Client method for returning the configuration information and metadata of the
27
27
  * specified user pool app client.</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,6 +24,26 @@ export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse,
24
24
  /**
25
25
  * @public
26
26
  * <p>Returns the configuration information and metadata of the specified user pool.</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>
27
47
  * @example
28
48
  * Use a bare-bones client and the command you need to make an API call.
29
49
  * ```javascript
@@ -24,6 +24,12 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {
24
24
  /**
25
25
  * @public
26
26
  * <p>Forgets the specified device.</p>
27
+ * <note>
28
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
29
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
30
+ * grant IAM permissions in policies. For more information about authorization models in
31
+ * Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p>
32
+ * </note>
27
33
  * @example
28
34
  * Use a bare-bones client and the command you need to make an API call.
29
35
  * ```javascript
@@ -47,7 +53,8 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {
47
53
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
48
54
  *
49
55
  * @throws {@link ForbiddenException} (client fault)
50
- * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
56
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
57
+ * ACL that's associated with your user pool.</p>
51
58
  *
52
59
  * @throws {@link InternalErrorException} (server fault)
53
60
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>