@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
@@ -27,10 +27,18 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
27
27
  * that is required to change the user's password. For the <code>Username</code> parameter,
28
28
  * you can use the username or user alias. The method used to send the confirmation code is
29
29
  * 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
30
- * User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If
31
- * neither a verified phone number nor a verified email exists, an
32
- * <code>InvalidParameterException</code> is thrown. To use the confirmation code for
33
- * resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
30
+ * User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. To
31
+ * 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>
32
+ * <p>If neither a verified phone number nor a verified email exists, this API returns
33
+ * <code>InvalidParameterException</code>. If your app client has a client secret and
34
+ * you don't provide a <code>SECRET_HASH</code> parameter, this API returns
35
+ * <code>NotAuthorizedException</code>.</p>
36
+ * <note>
37
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
38
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
39
+ * grant IAM permissions in policies. For more information about authorization models in
40
+ * 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>
41
+ * </note>
34
42
  * <note>
35
43
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
36
44
  * require you to register an origination phone number before you can send SMS messages
@@ -45,7 +53,7 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
45
53
  * mode</a>
46
54
  * </i>, you can send messages only to verified phone
47
55
  * numbers. After you test your app while in the sandbox environment, you can move out
48
- * 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
56
+ * 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
49
57
  * Developer Guide</i>.</p>
50
58
  * </note>
51
59
  * @example
@@ -92,7 +100,8 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
92
100
  * successfully.</p>
93
101
  *
94
102
  * @throws {@link ForbiddenException} (client fault)
95
- * <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>
103
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
104
+ * ACL that's associated with your user pool.</p>
96
105
  *
97
106
  * @throws {@link InternalErrorException} (server fault)
98
107
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -115,7 +124,7 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
115
124
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
116
125
  * <p>This exception is thrown when the trust relationship is not valid for the role
117
126
  * provided for SMS configuration. This can happen if you don't trust
118
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
127
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
119
128
  * not match what is provided in the SMS configuration for the user pool.</p>
120
129
  *
121
130
  * @throws {@link LimitExceededException} (client fault)
@@ -24,6 +24,12 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets the 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
@@ -60,7 +66,8 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
60
66
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
61
67
  *
62
68
  * @throws {@link ForbiddenException} (client fault)
63
- * <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>
69
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
70
+ * ACL that's associated with your user pool.</p>
64
71
  *
65
72
  * @throws {@link InternalErrorException} (server fault)
66
73
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -0,0 +1,102 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
+ import { GetLogDeliveryConfigurationRequest, GetLogDeliveryConfigurationResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetLogDeliveryConfigurationCommand}.
14
+ */
15
+ export interface GetLogDeliveryConfigurationCommandInput extends GetLogDeliveryConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetLogDeliveryConfigurationCommand}.
21
+ */
22
+ export interface GetLogDeliveryConfigurationCommandOutput extends GetLogDeliveryConfigurationResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Gets the detailed activity logging configuration for a user pool.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { CognitoIdentityProviderClient, GetLogDeliveryConfigurationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
31
+ * // const { CognitoIdentityProviderClient, GetLogDeliveryConfigurationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
32
+ * const client = new CognitoIdentityProviderClient(config);
33
+ * const input = { // GetLogDeliveryConfigurationRequest
34
+ * UserPoolId: "STRING_VALUE", // required
35
+ * };
36
+ * const command = new GetLogDeliveryConfigurationCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // GetLogDeliveryConfigurationResponse
39
+ * // LogDeliveryConfiguration: { // LogDeliveryConfigurationType
40
+ * // UserPoolId: "STRING_VALUE", // required
41
+ * // LogConfigurations: [ // LogConfigurationListType // required
42
+ * // { // LogConfigurationType
43
+ * // LogLevel: "ERROR", // required
44
+ * // EventSource: "userNotification", // required
45
+ * // CloudWatchLogsConfiguration: { // CloudWatchLogsConfigurationType
46
+ * // LogGroupArn: "STRING_VALUE",
47
+ * // },
48
+ * // },
49
+ * // ],
50
+ * // },
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param GetLogDeliveryConfigurationCommandInput - {@link GetLogDeliveryConfigurationCommandInput}
56
+ * @returns {@link GetLogDeliveryConfigurationCommandOutput}
57
+ * @see {@link GetLogDeliveryConfigurationCommandInput} for command's `input` shape.
58
+ * @see {@link GetLogDeliveryConfigurationCommandOutput} for command's `response` shape.
59
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
60
+ *
61
+ * @throws {@link InternalErrorException} (server fault)
62
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
63
+ *
64
+ * @throws {@link InvalidParameterException} (client fault)
65
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
66
+ * parameter.</p>
67
+ *
68
+ * @throws {@link NotAuthorizedException} (client fault)
69
+ * <p>This exception is thrown when a user isn't authorized.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
73
+ * resource.</p>
74
+ *
75
+ * @throws {@link TooManyRequestsException} (client fault)
76
+ * <p>This exception is thrown when the user has made too many requests for a given
77
+ * operation.</p>
78
+ *
79
+ * @throws {@link CognitoIdentityProviderServiceException}
80
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
81
+ *
82
+ */
83
+ export declare class GetLogDeliveryConfigurationCommand extends $Command<GetLogDeliveryConfigurationCommandInput, GetLogDeliveryConfigurationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
84
+ readonly input: GetLogDeliveryConfigurationCommandInput;
85
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
89
+ constructor(input: GetLogDeliveryConfigurationCommandInput);
90
+ /**
91
+ * @internal
92
+ */
93
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLogDeliveryConfigurationCommandInput, GetLogDeliveryConfigurationCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
97
+ private serialize;
98
+ /**
99
+ * @internal
100
+ */
101
+ private deserialize;
102
+ }
@@ -23,9 +23,11 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p>
27
- * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
28
- * but doesn't invalidate the original certificate.</p>
26
+ * <p>This method takes a user pool ID, and returns the signing certificate. The issued
27
+ * certificate is valid for 10 years from the date of issue.</p>
28
+ * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a
29
+ * new value in the response to <code>GetSigningCertificate</code>, but doesn't invalidate
30
+ * the original certificate.</p>
29
31
  * @example
30
32
  * Use a bare-bones client and the command you need to make an API call.
31
33
  * ```javascript
@@ -27,6 +27,12 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
27
27
  * message to a user with a code that they must return in a VerifyUserAttribute
28
28
  * request.</p>
29
29
  * <note>
30
+ * <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
31
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
32
+ * grant IAM permissions in policies. For more information about authorization models in
33
+ * 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>
34
+ * </note>
35
+ * <note>
30
36
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
31
37
  * require you to register an origination phone number before you can send SMS messages
32
38
  * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
@@ -40,7 +46,7 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
40
46
  * mode</a>
41
47
  * </i>, you can send messages only to verified phone
42
48
  * numbers. After you test your app while in the sandbox environment, you can move out
43
- * 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
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
44
50
  * Developer Guide</i>.</p>
45
51
  * </note>
46
52
  * @example
@@ -79,7 +85,8 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
79
85
  * successfully.</p>
80
86
  *
81
87
  * @throws {@link ForbiddenException} (client fault)
82
- * <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>
88
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
89
+ * ACL that's associated with your user pool.</p>
83
90
  *
84
91
  * @throws {@link InternalErrorException} (server fault)
85
92
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -102,7 +109,7 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
102
109
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
103
110
  * <p>This exception is thrown when the trust relationship is not valid for the role
104
111
  * provided for SMS configuration. This can happen if you don't trust
105
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
112
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
106
113
  * not match what is provided in the SMS configuration for the user pool.</p>
107
114
  *
108
115
  * @throws {@link LimitExceededException} (client fault)
@@ -24,6 +24,12 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets the user attributes and metadata 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
@@ -64,7 +70,8 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
64
70
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
65
71
  *
66
72
  * @throws {@link ForbiddenException} (client fault)
67
- * <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>
73
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
74
+ * ACL that's associated with your user pool.</p>
68
75
  *
69
76
  * @throws {@link InternalErrorException} (server fault)
70
77
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -23,9 +23,20 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito
27
- * has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens
28
- * for the duration of the 1-hour cookie validity period.</p>
26
+ * <p>Signs out a user from all devices. <code>GlobalSignOut</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 doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
36
+ * this operation, you can't use IAM credentials to authorize requests, and you can't
37
+ * grant IAM permissions in policies. For more information about authorization models in
38
+ * 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>
39
+ * </note>
29
40
  * @example
30
41
  * Use a bare-bones client and the command you need to make an API call.
31
42
  * ```javascript
@@ -48,7 +59,8 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
48
59
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
49
60
  *
50
61
  * @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>
62
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
63
+ * ACL that's associated with your user pool.</p>
52
64
  *
53
65
  * @throws {@link InternalErrorException} (server fault)
54
66
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -26,6 +26,12 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
26
26
  * <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
27
27
  * with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p>
28
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>
34
+ * <note>
29
35
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
30
36
  * require you to register an origination phone number before you can send SMS messages
31
37
  * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
@@ -39,7 +45,7 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
39
45
  * mode</a>
40
46
  * </i>, you can send messages only to verified phone
41
47
  * 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
48
+ * 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
49
  * Developer Guide</i>.</p>
44
50
  * </note>
45
51
  * @example
@@ -95,7 +101,8 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
95
101
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
96
102
  *
97
103
  * @throws {@link ForbiddenException} (client fault)
98
- * <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>
104
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
105
+ * ACL that's associated with your user pool.</p>
99
106
  *
100
107
  * @throws {@link InternalErrorException} (server fault)
101
108
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -114,7 +121,7 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
114
121
  * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
115
122
  * <p>This exception is thrown when the trust relationship is not valid for the role
116
123
  * provided for SMS configuration. This can happen if you don't trust
117
- * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
124
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
118
125
  * not match what is provided in the SMS configuration for the user pool.</p>
119
126
  *
120
127
  * @throws {@link InvalidUserPoolConfigurationException} (client fault)
@@ -24,6 +24,12 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the sign-in devices that Amazon Cognito has registered to the current 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
@@ -64,7 +70,8 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
64
70
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
65
71
  *
66
72
  * @throws {@link ForbiddenException} (client fault)
67
- * <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>
73
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web
74
+ * ACL that's associated with your user pool.</p>
68
75
  *
69
76
  * @throws {@link InternalErrorException} (server fault)
70
77
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
@@ -24,7 +24,26 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the groups associated with a 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 ListIdentityProvidersCommandOutput extends ListIdentityProvider
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists information about all IdPs 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 ListResourceServersCommandOutput extends ListResourceServersRes
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the resource servers 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
@@ -23,7 +23,27 @@ export interface ListUserImportJobsCommandOutput extends ListUserImportJobsRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the user import jobs.</p>
26
+ * <p>Lists user import jobs 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 ListUserPoolClientsCommandOutput extends ListUserPoolClientsRes
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the clients that have been created for 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,26 @@ export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __Met
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the user pools associated with an Amazon Web Services account.</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 ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the users in the Amazon Cognito user pool.</p>
26
+ * <p>Lists users and their basic details in 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,7 +24,26 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse,
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the users in 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