@aws-sdk/client-cognito-identity-provider 3.504.0 → 3.505.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/dist-types/commands/AddCustomAttributesCommand.d.ts +2 -2
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +2 -2
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +2 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +13 -13
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminDisableUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminEnableUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +2 -2
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +2 -2
- package/dist-types/commands/AdminGetUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +13 -13
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminListDevicesCommand.d.ts +2 -2
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +2 -2
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +2 -2
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +13 -13
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +13 -13
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +2 -2
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +2 -2
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +2 -2
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +2 -2
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +2 -2
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +13 -13
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +2 -2
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +3 -3
- package/dist-types/commands/ChangePasswordCommand.d.ts +4 -3
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +5 -4
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +3 -3
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +3 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +3 -3
- package/dist-types/commands/CreateResourceServerCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +15 -15
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +2 -2
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +4 -3
- package/dist-types/commands/DeleteUserCommand.d.ts +4 -3
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +3 -3
- package/dist-types/commands/ForgetDeviceCommand.d.ts +6 -4
- package/dist-types/commands/ForgotPasswordCommand.d.ts +14 -14
- package/dist-types/commands/GetDeviceCommand.d.ts +5 -4
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +15 -14
- package/dist-types/commands/GetUserCommand.d.ts +4 -3
- package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -3
- package/dist-types/commands/InitiateAuthCommand.d.ts +14 -14
- package/dist-types/commands/ListDevicesCommand.d.ts +6 -4
- package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +2 -2
- package/dist-types/commands/ListResourceServersCommand.d.ts +2 -2
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -2
- package/dist-types/commands/ListUserPoolsCommand.d.ts +3 -3
- package/dist-types/commands/ListUsersCommand.d.ts +2 -2
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -2
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +14 -14
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +14 -14
- package/dist-types/commands/RevokeTokenCommand.d.ts +3 -3
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -3
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +11 -11
- package/dist-types/commands/SetUserSettingsCommand.d.ts +4 -3
- package/dist-types/commands/SignUpCommand.d.ts +14 -14
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +3 -3
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -4
- package/dist-types/commands/UpdateGroupCommand.d.ts +2 -2
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +2 -2
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +15 -14
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +14 -14
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +2 -2
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +3 -3
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +4 -3
- package/dist-types/models/models_0.d.ts +473 -459
- package/dist-types/models/models_1.d.ts +191 -74
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/package.json +1 -1
|
@@ -30,26 +30,26 @@ declare const ResendConfirmationCodeCommand_base: {
|
|
|
30
30
|
* user pool.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
34
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
35
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
36
36
|
* </note>
|
|
37
37
|
* <note>
|
|
38
38
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
39
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
40
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
41
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
42
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
43
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
44
|
+
* in.</p>
|
|
45
45
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
46
|
-
*
|
|
46
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
47
47
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
48
|
-
*
|
|
48
|
+
* mode</a>
|
|
49
49
|
* </i>, you can send messages only to verified phone
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
50
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
51
|
+
* 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
|
|
52
|
+
* Developer Guide</i>.</p>
|
|
53
53
|
* </note>
|
|
54
54
|
* @example
|
|
55
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -35,26 +35,26 @@ declare const RespondToAuthChallengeCommand_base: {
|
|
|
35
35
|
* authentication challenge Lambda triggers</a>.</p>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
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 user pools API and user pool endpoints</a>.</p>
|
|
41
41
|
* </note>
|
|
42
42
|
* <note>
|
|
43
43
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
44
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
45
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
46
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
47
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
48
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
49
|
+
* in.</p>
|
|
50
50
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
51
|
-
*
|
|
51
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
52
52
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
53
|
-
*
|
|
53
|
+
* mode</a>
|
|
54
54
|
* </i>, you can send messages only to verified phone
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
55
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
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
|
|
57
|
+
* Developer Guide</i>.</p>
|
|
58
58
|
* </note>
|
|
59
59
|
* @example
|
|
60
60
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -31,9 +31,9 @@ declare const RevokeTokenCommand_base: {
|
|
|
31
31
|
* user APIs, or to authorize access to your resource server.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
35
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
36
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
37
37
|
* </note>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -35,11 +35,12 @@ declare const SetUserMFAPreferenceCommand_base: {
|
|
|
35
35
|
* unless device tracking is turned on and the device has been trusted. If you want MFA to
|
|
36
36
|
* be applied selectively based on the assessed risk level of sign-in attempts, deactivate
|
|
37
37
|
* MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
38
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
38
39
|
* <note>
|
|
39
40
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
41
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
42
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
43
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
43
44
|
* </note>
|
|
44
45
|
* @example
|
|
45
46
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,20 +29,20 @@ declare const SetUserPoolMfaConfigCommand_base: {
|
|
|
29
29
|
* <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
32
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
33
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
34
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
35
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
36
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
37
|
+
* in.</p>
|
|
38
38
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
39
|
-
*
|
|
39
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
40
40
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
41
|
-
*
|
|
41
|
+
* mode</a>
|
|
42
42
|
* </i>, you can send messages only to verified phone
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
43
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
44
|
+
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
|
|
45
|
+
* Developer Guide</i>.</p>
|
|
46
46
|
* </note>
|
|
47
47
|
* @example
|
|
48
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -30,11 +30,12 @@ declare const SetUserSettingsCommand_base: {
|
|
|
30
30
|
* <i>This action is no longer supported.</i> You can use it to configure
|
|
31
31
|
* only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
|
|
32
32
|
* 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>
|
|
33
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
33
34
|
* <note>
|
|
34
35
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
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 user pools API and user pool endpoints</a>.</p>
|
|
38
39
|
* </note>
|
|
39
40
|
* @example
|
|
40
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -30,26 +30,26 @@ declare const SignUpCommand_base: {
|
|
|
30
30
|
* user attributes.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
34
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
35
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
36
36
|
* </note>
|
|
37
37
|
* <note>
|
|
38
38
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
39
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
40
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
41
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
42
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
43
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
44
|
+
* in.</p>
|
|
45
45
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
46
|
-
*
|
|
46
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
47
47
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
48
|
-
*
|
|
48
|
+
* mode</a>
|
|
49
49
|
* </i>, you can send messages only to verified phone
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
50
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
51
|
+
* 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
|
|
52
|
+
* Developer Guide</i>.</p>
|
|
53
53
|
* </note>
|
|
54
54
|
* @example
|
|
55
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -31,9 +31,9 @@ declare const UpdateAuthEventFeedbackCommand_base: {
|
|
|
31
31
|
* as part of Amazon Cognito advanced security.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
35
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
36
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
37
37
|
* </note>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,12 +26,14 @@ declare const UpdateDeviceStatusCommand_base: {
|
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* <p>Updates the device status
|
|
29
|
+
* <p>Updates the device status. For more information about device authentication, see
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
31
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
30
32
|
* <note>
|
|
31
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
34
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
35
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
36
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
35
37
|
* </note>
|
|
36
38
|
* @example
|
|
37
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,8 +29,8 @@ declare const UpdateGroupCommand_base: {
|
|
|
29
29
|
* <p>Updates the specified group with the specified attributes.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
33
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
34
34
|
* <p class="title">
|
|
35
35
|
* <b>Learn more</b>
|
|
36
36
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const UpdateIdentityProviderCommand_base: {
|
|
|
29
29
|
* <p>Updates IdP information for a user pool.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
33
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
34
34
|
* <p class="title">
|
|
35
35
|
* <b>Learn more</b>
|
|
36
36
|
* </p>
|
|
@@ -33,8 +33,8 @@ declare const UpdateResourceServerCommand_base: {
|
|
|
33
33
|
* </important>
|
|
34
34
|
* <note>
|
|
35
35
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
36
|
-
*
|
|
37
|
-
*
|
|
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
38
|
* <p class="title">
|
|
39
39
|
* <b>Learn more</b>
|
|
40
40
|
* </p>
|
|
@@ -31,28 +31,29 @@ declare const UpdateUserAttributesCommand_base: {
|
|
|
31
31
|
* an attribute from your user, submit the attribute in your API request with a blank
|
|
32
32
|
* value. Custom attribute values in this request must include the <code>custom:</code>
|
|
33
33
|
* prefix.</p>
|
|
34
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
34
35
|
* <note>
|
|
35
36
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
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 user pools API and user pool endpoints</a>.</p>
|
|
39
40
|
* </note>
|
|
40
41
|
* <note>
|
|
41
42
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
43
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
44
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
45
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
46
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
47
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
48
|
+
* in.</p>
|
|
48
49
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
49
|
-
*
|
|
50
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
50
51
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
51
|
-
*
|
|
52
|
+
* mode</a>
|
|
52
53
|
* </i>, you can send messages only to verified phone
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
54
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
55
|
+
* 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
|
|
56
|
+
* Developer Guide</i>.</p>
|
|
56
57
|
* </note>
|
|
57
58
|
* @example
|
|
58
59
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -35,8 +35,8 @@ declare const UpdateUserPoolClientCommand_base: {
|
|
|
35
35
|
* 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>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
|
-
*
|
|
39
|
-
*
|
|
38
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
39
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
40
40
|
* <p class="title">
|
|
41
41
|
* <b>Learn more</b>
|
|
42
42
|
* </p>
|
|
@@ -28,20 +28,20 @@ declare const UpdateUserPoolCommand_base: {
|
|
|
28
28
|
* @public
|
|
29
29
|
* <note>
|
|
30
30
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
31
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
32
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
33
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
34
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
35
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
36
|
+
* in.</p>
|
|
37
37
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
38
|
-
*
|
|
38
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
39
39
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
40
|
-
*
|
|
40
|
+
* mode</a>
|
|
41
41
|
* </i>, you can send messages only to verified phone
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
42
|
+
* 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/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
|
|
44
|
+
* Developer Guide</i>.</p>
|
|
45
45
|
* </note>
|
|
46
46
|
* <p>Updates the specified user pool with the specified attributes. You can get a list of
|
|
47
47
|
* the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
@@ -50,8 +50,8 @@ declare const UpdateUserPoolCommand_base: {
|
|
|
50
50
|
* </important>
|
|
51
51
|
* <note>
|
|
52
52
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
53
|
-
*
|
|
54
|
-
*
|
|
53
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
54
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
55
55
|
* <p class="title">
|
|
56
56
|
* <b>Learn more</b>
|
|
57
57
|
* </p>
|
|
@@ -97,11 +97,11 @@ declare const UpdateUserPoolCommand_base: {
|
|
|
97
97
|
* CreateAuthChallenge: "STRING_VALUE",
|
|
98
98
|
* VerifyAuthChallengeResponse: "STRING_VALUE",
|
|
99
99
|
* PreTokenGeneration: "STRING_VALUE",
|
|
100
|
+
* UserMigration: "STRING_VALUE",
|
|
100
101
|
* PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
|
|
101
102
|
* LambdaVersion: "V1_0" || "V2_0", // required
|
|
102
103
|
* LambdaArn: "STRING_VALUE", // required
|
|
103
104
|
* },
|
|
104
|
-
* UserMigration: "STRING_VALUE",
|
|
105
105
|
* CustomSMSSender: { // CustomSMSLambdaVersionConfigType
|
|
106
106
|
* LambdaVersion: "V1_0", // required
|
|
107
107
|
* LambdaArn: "STRING_VALUE", // required
|
|
@@ -47,8 +47,8 @@ declare const UpdateUserPoolDomainCommand_base: {
|
|
|
47
47
|
* <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
|
|
48
48
|
* <note>
|
|
49
49
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
50
|
-
*
|
|
51
|
-
*
|
|
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
52
|
* <p class="title">
|
|
53
53
|
* <b>Learn more</b>
|
|
54
54
|
* </p>
|
|
@@ -31,9 +31,9 @@ declare const VerifySoftwareTokenCommand_base: {
|
|
|
31
31
|
* an access token or a session string, but not both.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
35
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
36
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
37
37
|
* </note>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -30,11 +30,12 @@ declare const VerifyUserAttributeCommand_base: {
|
|
|
30
30
|
* <p> If your user pool requires verification before Amazon Cognito updates the attribute value,
|
|
31
31
|
* VerifyUserAttribute updates the affected attribute to its pending value. For more
|
|
32
32
|
* information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html"> UserAttributeUpdateSettingsType</a>. </p>
|
|
33
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
33
34
|
* <note>
|
|
34
35
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
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 user pools API and user pool endpoints</a>.</p>
|
|
38
39
|
* </note>
|
|
39
40
|
* @example
|
|
40
41
|
* Use a bare-bones client and the command you need to make an API call.
|