@aws-sdk/client-cognito-identity-provider 3.382.0 → 3.385.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.
- package/README.md +83 -6
- package/dist-cjs/CognitoIdentityProvider.js +4 -0
- package/dist-cjs/commands/GetLogDeliveryConfigurationCommand.js +48 -0
- package/dist-cjs/commands/SetLogDeliveryConfigurationCommand.js +48 -0
- package/dist-cjs/commands/SetRiskConfigurationCommand.js +2 -1
- package/dist-cjs/commands/SetUICustomizationCommand.js +3 -3
- package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +2 -2
- package/dist-cjs/commands/SetUserSettingsCommand.js +2 -2
- package/dist-cjs/commands/VerifySoftwareTokenCommand.js +1 -1
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +9 -48
- package/dist-cjs/models/models_1.js +26 -9
- package/dist-cjs/protocols/Aws_json1_1.js +108 -4
- package/dist-es/CognitoIdentityProvider.js +4 -0
- package/dist-es/commands/GetLogDeliveryConfigurationCommand.js +44 -0
- package/dist-es/commands/SetLogDeliveryConfigurationCommand.js +44 -0
- package/dist-es/commands/SetRiskConfigurationCommand.js +2 -1
- package/dist-es/commands/SetUICustomizationCommand.js +1 -1
- package/dist-es/commands/SetUserMFAPreferenceCommand.js +1 -1
- package/dist-es/commands/SetUserSettingsCommand.js +1 -1
- package/dist-es/commands/VerifySoftwareTokenCommand.js +2 -2
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +6 -39
- package/dist-es/models/models_1.js +21 -8
- package/dist-es/protocols/Aws_json1_1.js +100 -0
- package/dist-types/CognitoIdentityProvider.d.ts +81 -6
- package/dist-types/CognitoIdentityProviderClient.d.ts +71 -8
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +20 -0
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +20 -1
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +20 -1
- package/dist-types/commands/AdminCreateUserCommand.d.ts +22 -4
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +20 -1
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +22 -4
- package/dist-types/commands/AdminDisableUserCommand.d.ts +23 -3
- package/dist-types/commands/AdminEnableUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +20 -1
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +20 -1
- package/dist-types/commands/AdminGetUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +22 -3
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +22 -3
- package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -1
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +20 -0
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +20 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +30 -11
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +24 -5
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +20 -0
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +31 -0
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +20 -0
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +20 -0
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +20 -1
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +31 -12
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +28 -7
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +8 -1
- package/dist-types/commands/ChangePasswordCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +10 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +20 -1
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +20 -0
- package/dist-types/commands/CreateResourceServerCommand.d.ts +20 -0
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +21 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +23 -0
- package/dist-types/commands/CreateUserPoolCommand.d.ts +28 -5
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +20 -0
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +8 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +9 -2
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +20 -0
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +20 -0
- package/dist-types/commands/ForgetDeviceCommand.d.ts +8 -1
- package/dist-types/commands/ForgotPasswordCommand.d.ts +16 -7
- package/dist-types/commands/GetDeviceCommand.d.ts +8 -1
- package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/GetSigningCertificateCommand.d.ts +5 -3
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -3
- package/dist-types/commands/GetUserCommand.d.ts +8 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +16 -4
- package/dist-types/commands/InitiateAuthCommand.d.ts +10 -3
- package/dist-types/commands/ListDevicesCommand.d.ts +8 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +20 -1
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +20 -0
- package/dist-types/commands/ListResourceServersCommand.d.ts +20 -0
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +21 -1
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +20 -0
- package/dist-types/commands/ListUserPoolsCommand.d.ts +20 -0
- package/dist-types/commands/ListUsersCommand.d.ts +21 -1
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +20 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -3
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +12 -5
- package/dist-types/commands/RevokeTokenCommand.d.ts +10 -3
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +111 -0
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +9 -2
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +3 -3
- package/dist-types/commands/SetUserSettingsCommand.d.ts +9 -2
- package/dist-types/commands/SignUpCommand.d.ts +10 -3
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +6 -0
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +8 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +20 -1
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +20 -0
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +20 -0
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -5
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +21 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +28 -7
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +20 -0
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +8 -1
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +13 -9
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +67 -6
- package/dist-types/models/models_0.d.ts +371 -319
- package/dist-types/models/models_1.d.ts +242 -18
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +34 -0
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetLogDeliveryConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserMFAPreferenceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +34 -52
- package/dist-types/ts3.4/models/models_1.d.ts +56 -3
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +3 -3
|
@@ -26,6 +26,12 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
|
|
|
26
26
|
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the
|
|
27
27
|
* user pool.</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 ResendConfirmationCodeCommandOutput extends ResendConfirmationC
|
|
|
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/
|
|
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
|
|
@@ -86,7 +92,8 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
|
|
|
86
92
|
* successfully.</p>
|
|
87
93
|
*
|
|
88
94
|
* @throws {@link ForbiddenException} (client fault)
|
|
89
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
95
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
96
|
+
* ACL that's associated with your user pool.</p>
|
|
90
97
|
*
|
|
91
98
|
* @throws {@link InternalErrorException} (server fault)
|
|
92
99
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -109,7 +116,7 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
|
|
|
109
116
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
110
117
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
111
118
|
* provided for SMS configuration. This can happen if you don't trust
|
|
112
|
-
*
|
|
119
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
113
120
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
114
121
|
*
|
|
115
122
|
* @throws {@link LimitExceededException} (client fault)
|
|
@@ -25,6 +25,12 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Responds to the authentication challenge.</p>
|
|
27
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>
|
|
33
|
+
* <note>
|
|
28
34
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
29
35
|
* require you to register an origination phone number before you can send SMS messages
|
|
30
36
|
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
@@ -38,7 +44,7 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
|
|
|
38
44
|
* mode</a>
|
|
39
45
|
* </i>, you can send messages only to verified phone
|
|
40
46
|
* 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/
|
|
47
|
+
* 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
48
|
* Developer Guide</i>.</p>
|
|
43
49
|
* </note>
|
|
44
50
|
* @example
|
|
@@ -96,8 +102,8 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
|
|
|
96
102
|
*
|
|
97
103
|
* @throws {@link AliasExistsException} (client fault)
|
|
98
104
|
* <p>This exception is thrown when a user tries to confirm the account with an email
|
|
99
|
-
* address or phone number that has already been supplied as an alias for a different
|
|
100
|
-
*
|
|
105
|
+
* address or phone number that has already been supplied as an alias for a different user
|
|
106
|
+
* profile. This exception indicates that an account with this email address or phone
|
|
101
107
|
* already exists in a user pool that you've configured to use email address or phone
|
|
102
108
|
* number as a sign-in alias.</p>
|
|
103
109
|
*
|
|
@@ -109,7 +115,8 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
|
|
|
109
115
|
* <p>This exception is thrown if a code has expired.</p>
|
|
110
116
|
*
|
|
111
117
|
* @throws {@link ForbiddenException} (client fault)
|
|
112
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
118
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
119
|
+
* ACL that's associated with your user pool.</p>
|
|
113
120
|
*
|
|
114
121
|
* @throws {@link InternalErrorException} (server fault)
|
|
115
122
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -131,7 +138,7 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
|
|
|
131
138
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
132
139
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
133
140
|
* provided for SMS configuration. This can happen if you don't trust
|
|
134
|
-
*
|
|
141
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
135
142
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
136
143
|
*
|
|
137
144
|
* @throws {@link InvalidUserPoolConfigurationException} (client fault)
|
|
@@ -24,8 +24,14 @@ export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __Metadat
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Revokes all of the access tokens generated by, and at the same time as, the specified
|
|
27
|
-
* refresh token. After a token is revoked, you can't use the revoked token to access
|
|
28
|
-
*
|
|
27
|
+
* refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito
|
|
28
|
+
* user APIs, or to authorize access to your resource server.</p>
|
|
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>
|
|
29
35
|
* @example
|
|
30
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
37
|
* ```javascript
|
|
@@ -50,7 +56,8 @@ export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __Metadat
|
|
|
50
56
|
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
51
57
|
*
|
|
52
58
|
* @throws {@link ForbiddenException} (client fault)
|
|
53
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
59
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
60
|
+
* ACL that's associated with your user pool.</p>
|
|
54
61
|
*
|
|
55
62
|
* @throws {@link InternalErrorException} (server fault)
|
|
56
63
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -0,0 +1,111 @@
|
|
|
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 { SetLogDeliveryConfigurationRequest, SetLogDeliveryConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SetLogDeliveryConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SetLogDeliveryConfigurationCommandInput extends SetLogDeliveryConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SetLogDeliveryConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SetLogDeliveryConfigurationCommandOutput extends SetLogDeliveryConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Sets up or modifies the detailed activity logging configuration of 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, SetLogDeliveryConfigurationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
31
|
+
* // const { CognitoIdentityProviderClient, SetLogDeliveryConfigurationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
32
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
33
|
+
* const input = { // SetLogDeliveryConfigurationRequest
|
|
34
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
35
|
+
* LogConfigurations: [ // LogConfigurationListType // required
|
|
36
|
+
* { // LogConfigurationType
|
|
37
|
+
* LogLevel: "ERROR", // required
|
|
38
|
+
* EventSource: "userNotification", // required
|
|
39
|
+
* CloudWatchLogsConfiguration: { // CloudWatchLogsConfigurationType
|
|
40
|
+
* LogGroupArn: "STRING_VALUE",
|
|
41
|
+
* },
|
|
42
|
+
* },
|
|
43
|
+
* ],
|
|
44
|
+
* };
|
|
45
|
+
* const command = new SetLogDeliveryConfigurationCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // SetLogDeliveryConfigurationResponse
|
|
48
|
+
* // LogDeliveryConfiguration: { // LogDeliveryConfigurationType
|
|
49
|
+
* // UserPoolId: "STRING_VALUE", // required
|
|
50
|
+
* // LogConfigurations: [ // LogConfigurationListType // required
|
|
51
|
+
* // { // LogConfigurationType
|
|
52
|
+
* // LogLevel: "ERROR", // required
|
|
53
|
+
* // EventSource: "userNotification", // required
|
|
54
|
+
* // CloudWatchLogsConfiguration: { // CloudWatchLogsConfigurationType
|
|
55
|
+
* // LogGroupArn: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // },
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param SetLogDeliveryConfigurationCommandInput - {@link SetLogDeliveryConfigurationCommandInput}
|
|
65
|
+
* @returns {@link SetLogDeliveryConfigurationCommandOutput}
|
|
66
|
+
* @see {@link SetLogDeliveryConfigurationCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link SetLogDeliveryConfigurationCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
71
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
75
|
+
* parameter.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
78
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
82
|
+
* resource.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
85
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
86
|
+
* operation.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
export declare class SetLogDeliveryConfigurationCommand extends $Command<SetLogDeliveryConfigurationCommandInput, SetLogDeliveryConfigurationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
|
|
93
|
+
readonly input: SetLogDeliveryConfigurationCommandInput;
|
|
94
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
constructor(input: SetLogDeliveryConfigurationCommandInput);
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetLogDeliveryConfigurationCommandInput, SetLogDeliveryConfigurationCommandOutput>;
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
private serialize;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private deserialize;
|
|
111
|
+
}
|
|
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
5
|
-
import { SetRiskConfigurationRequest
|
|
5
|
+
import { SetRiskConfigurationRequest } from "../models/models_0";
|
|
6
|
+
import { SetRiskConfigurationResponse } from "../models/models_1";
|
|
6
7
|
/**
|
|
7
8
|
* @public
|
|
8
9
|
*/
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
5
|
-
import { SetUICustomizationRequest, SetUICustomizationResponse } from "../models/
|
|
5
|
+
import { SetUICustomizationRequest, SetUICustomizationResponse } from "../models/models_1";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
8
8
|
*/
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
5
|
-
import { SetUserMFAPreferenceRequest, SetUserMFAPreferenceResponse } from "../models/
|
|
5
|
+
import { SetUserMFAPreferenceRequest, SetUserMFAPreferenceResponse } from "../models/models_1";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
8
8
|
*/
|
|
@@ -32,6 +32,12 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR
|
|
|
32
32
|
* unless device tracking is turned on and the device has been trusted. If you want MFA to
|
|
33
33
|
* be applied selectively based on the assessed risk level of sign-in attempts, deactivate
|
|
34
34
|
* MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
35
|
+
* <note>
|
|
36
|
+
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
37
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
38
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
39
|
+
* 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>
|
|
40
|
+
* </note>
|
|
35
41
|
* @example
|
|
36
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
43
|
* ```javascript
|
|
@@ -62,7 +68,8 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR
|
|
|
62
68
|
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
63
69
|
*
|
|
64
70
|
* @throws {@link ForbiddenException} (client fault)
|
|
65
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
71
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
72
|
+
* ACL that's associated with your user pool.</p>
|
|
66
73
|
*
|
|
67
74
|
* @throws {@link InternalErrorException} (server fault)
|
|
68
75
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
5
|
-
import { SetUserPoolMfaConfigRequest, SetUserPoolMfaConfigResponse } from "../models/
|
|
5
|
+
import { SetUserPoolMfaConfigRequest, SetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
8
8
|
*/
|
|
@@ -38,7 +38,7 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
|
|
|
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/
|
|
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
44
|
* @example
|
|
@@ -101,7 +101,7 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
|
|
|
101
101
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
102
102
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
103
103
|
* provided for SMS configuration. This can happen if you don't trust
|
|
104
|
-
*
|
|
104
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
105
105
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
106
106
|
*
|
|
107
107
|
* @throws {@link NotAuthorizedException} (client fault)
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
5
|
-
import { SetUserSettingsRequest, SetUserSettingsResponse } from "../models/
|
|
5
|
+
import { SetUserSettingsRequest, SetUserSettingsResponse } from "../models/models_1";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
8
8
|
*/
|
|
@@ -27,6 +27,12 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
|
|
|
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_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
32
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
33
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
34
|
+
* 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>
|
|
35
|
+
* </note>
|
|
30
36
|
* @example
|
|
31
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
38
|
* ```javascript
|
|
@@ -55,7 +61,8 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
|
|
|
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
|
|
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>
|
|
@@ -26,6 +26,12 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
|
|
|
26
26
|
* <p>Registers the user in the specified user pool and creates a user name, password, and
|
|
27
27
|
* user attributes.</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 SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
|
|
|
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/
|
|
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
|
|
@@ -101,7 +107,8 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
|
|
|
101
107
|
* successfully.</p>
|
|
102
108
|
*
|
|
103
109
|
* @throws {@link ForbiddenException} (client fault)
|
|
104
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
110
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
111
|
+
* ACL that's associated with your user pool.</p>
|
|
105
112
|
*
|
|
106
113
|
* @throws {@link InternalErrorException} (server fault)
|
|
107
114
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -127,7 +134,7 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
|
|
|
127
134
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
128
135
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
129
136
|
* provided for SMS configuration. This can happen if you don't trust
|
|
130
|
-
*
|
|
137
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
131
138
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
132
139
|
*
|
|
133
140
|
* @throws {@link NotAuthorizedException} (client fault)
|
|
@@ -26,6 +26,12 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee
|
|
|
26
26
|
* <p>Provides the feedback for an authentication event, whether it was from a valid user or
|
|
27
27
|
* not. This feedback is used for improving the risk evaluation decision for the user pool
|
|
28
28
|
* as part of Amazon Cognito advanced security.</p>
|
|
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>
|
|
29
35
|
* @example
|
|
30
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
37
|
* ```javascript
|
|
@@ -24,6 +24,12 @@ export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Updates the device status.</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 UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
|
|
|
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
|
|
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>
|
|
@@ -24,7 +24,26 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Updates the specified group with the specified attributes.</p>
|
|
27
|
-
* <
|
|
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 UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Updates IdP information 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
|
|
@@ -28,6 +28,26 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
|
|
|
28
28
|
* <p>If you don't provide a value for an attribute, it is set to the default
|
|
29
29
|
* value.</p>
|
|
30
30
|
* </important>
|
|
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
|
|
@@ -25,6 +25,12 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Allows a user to update a specific attribute (one at a time).</p>
|
|
27
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>
|
|
33
|
+
* <note>
|
|
28
34
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
29
35
|
* require you to register an origination phone number before you can send SMS messages
|
|
30
36
|
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
@@ -38,7 +44,7 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
|
|
|
38
44
|
* mode</a>
|
|
39
45
|
* </i>, you can send messages only to verified phone
|
|
40
46
|
* 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/
|
|
47
|
+
* 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
48
|
* Developer Guide</i>.</p>
|
|
43
49
|
* </note>
|
|
44
50
|
* @example
|
|
@@ -81,8 +87,8 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
|
|
|
81
87
|
*
|
|
82
88
|
* @throws {@link AliasExistsException} (client fault)
|
|
83
89
|
* <p>This exception is thrown when a user tries to confirm the account with an email
|
|
84
|
-
* address or phone number that has already been supplied as an alias for a different
|
|
85
|
-
*
|
|
90
|
+
* address or phone number that has already been supplied as an alias for a different user
|
|
91
|
+
* profile. This exception indicates that an account with this email address or phone
|
|
86
92
|
* already exists in a user pool that you've configured to use email address or phone
|
|
87
93
|
* number as a sign-in alias.</p>
|
|
88
94
|
*
|
|
@@ -98,7 +104,8 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
|
|
|
98
104
|
* <p>This exception is thrown if a code has expired.</p>
|
|
99
105
|
*
|
|
100
106
|
* @throws {@link ForbiddenException} (client fault)
|
|
101
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
107
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
108
|
+
* ACL that's associated with your user pool.</p>
|
|
102
109
|
*
|
|
103
110
|
* @throws {@link InternalErrorException} (server fault)
|
|
104
111
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -121,7 +128,7 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
|
|
|
121
128
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
122
129
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
123
130
|
* provided for SMS configuration. This can happen if you don't trust
|
|
124
|
-
*
|
|
131
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
125
132
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
126
133
|
*
|
|
127
134
|
* @throws {@link NotAuthorizedException} (client fault)
|
|
@@ -26,11 +26,30 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
|
|
|
26
26
|
* <p>Updates the specified user pool app client with the specified attributes. You can get
|
|
27
27
|
* a list of the current user pool app client settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
|
|
28
28
|
* <important>
|
|
29
|
-
* <p>If you don't provide a value for an attribute,
|
|
30
|
-
* value.</p>
|
|
29
|
+
* <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
|
|
31
30
|
* </important>
|
|
32
31
|
* <p>You can also use this operation to enable token revocation for user pool clients. For
|
|
33
32
|
* 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>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
36
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
37
|
+
* <p class="title">
|
|
38
|
+
* <b>Learn more</b>
|
|
39
|
+
* </p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
49
|
+
* </p>
|
|
50
|
+
* </li>
|
|
51
|
+
* </ul>
|
|
52
|
+
* </note>
|
|
34
53
|
* @example
|
|
35
54
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
55
|
* ```javascript
|