@aws-sdk/client-cognito-identity-provider 3.503.1 → 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 +3 -3
|
@@ -29,8 +29,8 @@ declare const AddCustomAttributesCommand_base: {
|
|
|
29
29
|
* <p>Adds additional user attributes to the user pool schema.</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>
|
|
@@ -31,8 +31,8 @@ declare const AdminAddUserToGroupCommand_base: {
|
|
|
31
31
|
* identity tokens.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
35
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
36
36
|
* <p class="title">
|
|
37
37
|
* <b>Learn more</b>
|
|
38
38
|
* </p>
|
|
@@ -37,8 +37,8 @@ declare const AdminConfirmSignUpCommand_base: {
|
|
|
37
37
|
* when they respond to their invitation email message and choose a password.</p>
|
|
38
38
|
* <note>
|
|
39
39
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
40
|
-
*
|
|
41
|
-
*
|
|
40
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
41
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
42
42
|
* <p class="title">
|
|
43
43
|
* <b>Learn more</b>
|
|
44
44
|
* </p>
|
|
@@ -31,20 +31,20 @@ declare const AdminCreateUserCommand_base: {
|
|
|
31
31
|
* email or phone (SMS).</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
34
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
35
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
36
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
37
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
38
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
39
|
+
* in.</p>
|
|
40
40
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
41
|
-
*
|
|
41
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
42
42
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
43
|
-
*
|
|
43
|
+
* mode</a>
|
|
44
44
|
* </i>, you can send messages only to verified phone
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
45
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
46
|
+
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
|
|
47
|
+
* Developer Guide</i>.</p>
|
|
48
48
|
* </note>
|
|
49
49
|
* <p>This message is based on a template that you configured in your call to create or
|
|
50
50
|
* update a user pool. This template includes your custom sign-up instructions and
|
|
@@ -55,8 +55,8 @@ declare const AdminCreateUserCommand_base: {
|
|
|
55
55
|
* they sign in and change their password.</p>
|
|
56
56
|
* <note>
|
|
57
57
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
58
|
-
*
|
|
59
|
-
*
|
|
58
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
59
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
60
60
|
* <p class="title">
|
|
61
61
|
* <b>Learn more</b>
|
|
62
62
|
* </p>
|
|
@@ -30,8 +30,8 @@ declare const AdminDeleteUserAttributesCommand_base: {
|
|
|
30
30
|
* user.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
-
*
|
|
34
|
-
*
|
|
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
35
|
* <p class="title">
|
|
36
36
|
* <b>Learn more</b>
|
|
37
37
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const AdminDeleteUserCommand_base: {
|
|
|
29
29
|
* <p>Deletes a user as an administrator. Works on any user.</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>
|
|
@@ -54,8 +54,8 @@ declare const AdminDisableProviderForUserCommand_base: {
|
|
|
54
54
|
* assertion.</p>
|
|
55
55
|
* <note>
|
|
56
56
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
57
|
-
*
|
|
58
|
-
*
|
|
57
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
58
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
59
59
|
* <p class="title">
|
|
60
60
|
* <b>Learn more</b>
|
|
61
61
|
* </p>
|
|
@@ -31,8 +31,8 @@ declare const AdminDisableUserCommand_base: {
|
|
|
31
31
|
* <code>ListUsers</code> API requests.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
35
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
36
36
|
* <p class="title">
|
|
37
37
|
* <b>Learn more</b>
|
|
38
38
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const AdminEnableUserCommand_base: {
|
|
|
29
29
|
* <p>Enables the specified user as an administrator. Works on any user.</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 AdminForgetDeviceCommand_base: {
|
|
|
29
29
|
* <p>Forgets the device, as an administrator.</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 AdminGetDeviceCommand_base: {
|
|
|
29
29
|
* <p>Gets the device, as an administrator.</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>
|
|
@@ -30,8 +30,8 @@ declare const AdminGetUserCommand_base: {
|
|
|
30
30
|
* user.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
-
*
|
|
34
|
-
*
|
|
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
35
|
* <p class="title">
|
|
36
36
|
* <b>Learn more</b>
|
|
37
37
|
* </p>
|
|
@@ -29,25 +29,25 @@ declare const AdminInitiateAuthCommand_base: {
|
|
|
29
29
|
* <p>Initiates the authentication flow, as an administrator.</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
|
* <note>
|
|
48
48
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
49
|
-
*
|
|
50
|
-
*
|
|
49
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
50
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
51
51
|
* <p class="title">
|
|
52
52
|
* <b>Learn more</b>
|
|
53
53
|
* </p>
|
|
@@ -45,8 +45,8 @@ declare const AdminLinkProviderForUserCommand_base: {
|
|
|
45
45
|
* </important>
|
|
46
46
|
* <note>
|
|
47
47
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
48
|
-
*
|
|
49
|
-
*
|
|
48
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
49
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
50
50
|
* <p class="title">
|
|
51
51
|
* <b>Learn more</b>
|
|
52
52
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const AdminListDevicesCommand_base: {
|
|
|
29
29
|
* <p>Lists devices, as an administrator.</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 AdminListGroupsForUserCommand_base: {
|
|
|
29
29
|
* <p>Lists the groups that a user belongs to.</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>
|
|
@@ -30,8 +30,8 @@ declare const AdminListUserAuthEventsCommand_base: {
|
|
|
30
30
|
* security.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
-
*
|
|
34
|
-
*
|
|
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
35
|
* <p class="title">
|
|
36
36
|
* <b>Learn more</b>
|
|
37
37
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const AdminRemoveUserFromGroupCommand_base: {
|
|
|
29
29
|
* <p>Removes the specified user from the specified group.</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>
|
|
@@ -30,20 +30,20 @@ declare const AdminResetUserPasswordCommand_base: {
|
|
|
30
30
|
* user.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
33
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
34
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
35
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
36
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
37
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
38
|
+
* in.</p>
|
|
39
39
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
40
|
-
*
|
|
40
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
41
41
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
42
|
-
*
|
|
42
|
+
* mode</a>
|
|
43
43
|
* </i>, you can send messages only to verified phone
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
44
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
45
|
+
* 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
|
|
46
|
+
* Developer Guide</i>.</p>
|
|
47
47
|
* </note>
|
|
48
48
|
* <p>Deactivates a user's password, requiring them to change it. If a user tries to sign in
|
|
49
49
|
* after the API is called, Amazon Cognito responds with a
|
|
@@ -55,8 +55,8 @@ declare const AdminResetUserPasswordCommand_base: {
|
|
|
55
55
|
* change their password.</p>
|
|
56
56
|
* <note>
|
|
57
57
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
58
|
-
*
|
|
59
|
-
*
|
|
58
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
59
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
60
60
|
* <p class="title">
|
|
61
61
|
* <b>Learn more</b>
|
|
62
62
|
* </p>
|
|
@@ -35,25 +35,25 @@ declare const AdminRespondToAuthChallengeCommand_base: {
|
|
|
35
35
|
* authentication challenge Lambda triggers</a>.</p>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
38
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
39
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
40
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
41
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
42
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
43
|
+
* in.</p>
|
|
44
44
|
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
45
|
-
*
|
|
45
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
46
46
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
47
|
-
*
|
|
47
|
+
* mode</a>
|
|
48
48
|
* </i>, you can send messages only to verified phone
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
49
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
50
|
+
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
|
|
51
|
+
* Developer Guide</i>.</p>
|
|
52
52
|
* </note>
|
|
53
53
|
* <note>
|
|
54
54
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
55
|
-
*
|
|
56
|
-
*
|
|
55
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
56
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
57
57
|
* <p class="title">
|
|
58
58
|
* <b>Learn more</b>
|
|
59
59
|
* </p>
|
|
@@ -33,8 +33,8 @@ declare const AdminSetUserMFAPreferenceCommand_base: {
|
|
|
33
33
|
* choose an MFA option will be returned during sign-in.</p>
|
|
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>
|
|
@@ -49,8 +49,8 @@ declare const AdminSetUserPasswordCommand_base: {
|
|
|
49
49
|
* profile</a>.</p>
|
|
50
50
|
* <note>
|
|
51
51
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
52
|
-
*
|
|
53
|
-
*
|
|
52
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
53
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
54
54
|
* <p class="title">
|
|
55
55
|
* <b>Learn more</b>
|
|
56
56
|
* </p>
|
|
@@ -32,8 +32,8 @@ declare const AdminSetUserSettingsCommand_base: {
|
|
|
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_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
|
|
33
33
|
* <note>
|
|
34
34
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
|
-
*
|
|
36
|
-
*
|
|
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
37
|
* <p class="title">
|
|
38
38
|
* <b>Learn more</b>
|
|
39
39
|
* </p>
|
|
@@ -31,8 +31,8 @@ declare const AdminUpdateAuthEventFeedbackCommand_base: {
|
|
|
31
31
|
* part of Amazon Cognito advanced security.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
35
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
36
36
|
* <p class="title">
|
|
37
37
|
* <b>Learn more</b>
|
|
38
38
|
* </p>
|
|
@@ -29,8 +29,8 @@ declare const AdminUpdateDeviceStatusCommand_base: {
|
|
|
29
29
|
* <p>Updates the device status as an administrator.</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>
|
|
@@ -28,20 +28,20 @@ declare const AdminUpdateUserAttributesCommand_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's attributes, including developer attributes, as an
|
|
47
47
|
* administrator. Works on any user. To delete an attribute from your user, submit the
|
|
@@ -52,8 +52,8 @@ declare const AdminUpdateUserAttributesCommand_base: {
|
|
|
52
52
|
* email as verified.</p>
|
|
53
53
|
* <note>
|
|
54
54
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
55
|
-
*
|
|
56
|
-
*
|
|
55
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
56
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
57
57
|
* <p class="title">
|
|
58
58
|
* <b>Learn more</b>
|
|
59
59
|
* </p>
|
|
@@ -52,8 +52,8 @@ declare const AdminUserGlobalSignOutCommand_base: {
|
|
|
52
52
|
* <p>Other requests might be valid until your user's token expires.</p>
|
|
53
53
|
* <note>
|
|
54
54
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
55
|
-
*
|
|
56
|
-
*
|
|
55
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
56
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
57
57
|
* <p class="title">
|
|
58
58
|
* <b>Learn more</b>
|
|
59
59
|
* </p>
|
|
@@ -45,9 +45,9 @@ declare const AssociateSoftwareTokenCommand_base: {
|
|
|
45
45
|
* </note>
|
|
46
46
|
* <note>
|
|
47
47
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
48
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
49
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
50
|
+
* 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>
|
|
51
51
|
* </note>
|
|
52
52
|
* @example
|
|
53
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,11 +27,12 @@ declare const ChangePasswordCommand_base: {
|
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
29
|
* <p>Changes the password for a specified user in a user pool.</p>
|
|
30
|
+
* <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
31
|
* <note>
|
|
31
32
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
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>
|
|
35
36
|
* </note>
|
|
36
37
|
* @example
|
|
37
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,12 +27,13 @@ declare const ConfirmDeviceCommand_base: {
|
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
29
|
* <p>Confirms tracking of the device. This API call is the call that begins device
|
|
30
|
-
* tracking
|
|
30
|
+
* tracking. For more information about device authentication, see <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>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
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>
|
|
36
37
|
* </note>
|
|
37
38
|
* @example
|
|
38
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,9 +29,9 @@ declare const ConfirmForgotPasswordCommand_base: {
|
|
|
29
29
|
* <p>Allows a user to enter a confirmation code to reset a forgotten password.</p>
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
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 user pools API and user pool endpoints</a>.</p>
|
|
35
35
|
* </note>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -40,9 +40,9 @@ declare const ConfirmSignUpCommand_base: {
|
|
|
40
40
|
* code. Instead, they receive a temporary password.</p>
|
|
41
41
|
* <note>
|
|
42
42
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
43
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
44
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
45
|
+
* 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>
|
|
46
46
|
* </note>
|
|
47
47
|
* @example
|
|
48
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,8 +29,8 @@ declare const CreateGroupCommand_base: {
|
|
|
29
29
|
* <p>Creates a new group in the specified 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>
|