@aws-sdk/client-cognito-identity-provider 3.53.0 → 3.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (148) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/CognitoIdentityProviderClient.js +12 -12
  3. package/dist-cjs/commands/AddCustomAttributesCommand.js +4 -4
  4. package/dist-cjs/commands/AdminAddUserToGroupCommand.js +4 -4
  5. package/dist-cjs/commands/AdminConfirmSignUpCommand.js +4 -4
  6. package/dist-cjs/commands/AdminCreateUserCommand.js +4 -4
  7. package/dist-cjs/commands/AdminDeleteUserAttributesCommand.js +4 -4
  8. package/dist-cjs/commands/AdminDeleteUserCommand.js +4 -4
  9. package/dist-cjs/commands/AdminDisableProviderForUserCommand.js +4 -4
  10. package/dist-cjs/commands/AdminDisableUserCommand.js +4 -4
  11. package/dist-cjs/commands/AdminEnableUserCommand.js +4 -4
  12. package/dist-cjs/commands/AdminForgetDeviceCommand.js +4 -4
  13. package/dist-cjs/commands/AdminGetDeviceCommand.js +4 -4
  14. package/dist-cjs/commands/AdminGetUserCommand.js +4 -4
  15. package/dist-cjs/commands/AdminInitiateAuthCommand.js +4 -4
  16. package/dist-cjs/commands/AdminLinkProviderForUserCommand.js +4 -4
  17. package/dist-cjs/commands/AdminListDevicesCommand.js +4 -4
  18. package/dist-cjs/commands/AdminListGroupsForUserCommand.js +4 -4
  19. package/dist-cjs/commands/AdminListUserAuthEventsCommand.js +4 -4
  20. package/dist-cjs/commands/AdminRemoveUserFromGroupCommand.js +4 -4
  21. package/dist-cjs/commands/AdminResetUserPasswordCommand.js +4 -4
  22. package/dist-cjs/commands/AdminRespondToAuthChallengeCommand.js +4 -4
  23. package/dist-cjs/commands/AdminSetUserMFAPreferenceCommand.js +4 -4
  24. package/dist-cjs/commands/AdminSetUserPasswordCommand.js +4 -4
  25. package/dist-cjs/commands/AdminSetUserSettingsCommand.js +4 -4
  26. package/dist-cjs/commands/AdminUpdateAuthEventFeedbackCommand.js +4 -4
  27. package/dist-cjs/commands/AdminUpdateDeviceStatusCommand.js +4 -4
  28. package/dist-cjs/commands/AdminUpdateUserAttributesCommand.js +4 -4
  29. package/dist-cjs/commands/AdminUserGlobalSignOutCommand.js +4 -4
  30. package/dist-cjs/commands/AssociateSoftwareTokenCommand.js +4 -4
  31. package/dist-cjs/commands/ChangePasswordCommand.js +3 -3
  32. package/dist-cjs/commands/ConfirmDeviceCommand.js +4 -4
  33. package/dist-cjs/commands/ConfirmForgotPasswordCommand.js +3 -3
  34. package/dist-cjs/commands/ConfirmSignUpCommand.js +3 -3
  35. package/dist-cjs/commands/CreateGroupCommand.js +4 -4
  36. package/dist-cjs/commands/CreateIdentityProviderCommand.js +4 -4
  37. package/dist-cjs/commands/CreateResourceServerCommand.js +4 -4
  38. package/dist-cjs/commands/CreateUserImportJobCommand.js +4 -4
  39. package/dist-cjs/commands/CreateUserPoolClientCommand.js +4 -4
  40. package/dist-cjs/commands/CreateUserPoolCommand.js +4 -4
  41. package/dist-cjs/commands/CreateUserPoolDomainCommand.js +4 -4
  42. package/dist-cjs/commands/DeleteGroupCommand.js +4 -4
  43. package/dist-cjs/commands/DeleteIdentityProviderCommand.js +4 -4
  44. package/dist-cjs/commands/DeleteResourceServerCommand.js +4 -4
  45. package/dist-cjs/commands/DeleteUserAttributesCommand.js +3 -3
  46. package/dist-cjs/commands/DeleteUserCommand.js +3 -3
  47. package/dist-cjs/commands/DeleteUserPoolClientCommand.js +4 -4
  48. package/dist-cjs/commands/DeleteUserPoolCommand.js +4 -4
  49. package/dist-cjs/commands/DeleteUserPoolDomainCommand.js +4 -4
  50. package/dist-cjs/commands/DescribeIdentityProviderCommand.js +4 -4
  51. package/dist-cjs/commands/DescribeResourceServerCommand.js +4 -4
  52. package/dist-cjs/commands/DescribeRiskConfigurationCommand.js +4 -4
  53. package/dist-cjs/commands/DescribeUserImportJobCommand.js +4 -4
  54. package/dist-cjs/commands/DescribeUserPoolClientCommand.js +4 -4
  55. package/dist-cjs/commands/DescribeUserPoolCommand.js +4 -4
  56. package/dist-cjs/commands/DescribeUserPoolDomainCommand.js +4 -4
  57. package/dist-cjs/commands/ForgetDeviceCommand.js +4 -4
  58. package/dist-cjs/commands/ForgotPasswordCommand.js +3 -3
  59. package/dist-cjs/commands/GetCSVHeaderCommand.js +4 -4
  60. package/dist-cjs/commands/GetDeviceCommand.js +4 -4
  61. package/dist-cjs/commands/GetGroupCommand.js +4 -4
  62. package/dist-cjs/commands/GetIdentityProviderByIdentifierCommand.js +4 -4
  63. package/dist-cjs/commands/GetSigningCertificateCommand.js +4 -4
  64. package/dist-cjs/commands/GetUICustomizationCommand.js +4 -4
  65. package/dist-cjs/commands/GetUserAttributeVerificationCodeCommand.js +3 -3
  66. package/dist-cjs/commands/GetUserCommand.js +3 -3
  67. package/dist-cjs/commands/GetUserPoolMfaConfigCommand.js +4 -4
  68. package/dist-cjs/commands/GlobalSignOutCommand.js +4 -4
  69. package/dist-cjs/commands/InitiateAuthCommand.js +3 -3
  70. package/dist-cjs/commands/ListDevicesCommand.js +4 -4
  71. package/dist-cjs/commands/ListGroupsCommand.js +4 -4
  72. package/dist-cjs/commands/ListIdentityProvidersCommand.js +4 -4
  73. package/dist-cjs/commands/ListResourceServersCommand.js +4 -4
  74. package/dist-cjs/commands/ListTagsForResourceCommand.js +4 -4
  75. package/dist-cjs/commands/ListUserImportJobsCommand.js +4 -4
  76. package/dist-cjs/commands/ListUserPoolClientsCommand.js +4 -4
  77. package/dist-cjs/commands/ListUserPoolsCommand.js +4 -4
  78. package/dist-cjs/commands/ListUsersCommand.js +4 -4
  79. package/dist-cjs/commands/ListUsersInGroupCommand.js +4 -4
  80. package/dist-cjs/commands/ResendConfirmationCodeCommand.js +3 -3
  81. package/dist-cjs/commands/RespondToAuthChallengeCommand.js +3 -3
  82. package/dist-cjs/commands/RevokeTokenCommand.js +4 -4
  83. package/dist-cjs/commands/SetRiskConfigurationCommand.js +4 -4
  84. package/dist-cjs/commands/SetUICustomizationCommand.js +4 -4
  85. package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +4 -4
  86. package/dist-cjs/commands/SetUserPoolMfaConfigCommand.js +4 -4
  87. package/dist-cjs/commands/SetUserSettingsCommand.js +3 -3
  88. package/dist-cjs/commands/SignUpCommand.js +3 -3
  89. package/dist-cjs/commands/StartUserImportJobCommand.js +4 -4
  90. package/dist-cjs/commands/StopUserImportJobCommand.js +4 -4
  91. package/dist-cjs/commands/TagResourceCommand.js +4 -4
  92. package/dist-cjs/commands/UntagResourceCommand.js +4 -4
  93. package/dist-cjs/commands/UpdateAuthEventFeedbackCommand.js +4 -4
  94. package/dist-cjs/commands/UpdateDeviceStatusCommand.js +4 -4
  95. package/dist-cjs/commands/UpdateGroupCommand.js +4 -4
  96. package/dist-cjs/commands/UpdateIdentityProviderCommand.js +4 -4
  97. package/dist-cjs/commands/UpdateResourceServerCommand.js +4 -4
  98. package/dist-cjs/commands/UpdateUserAttributesCommand.js +3 -3
  99. package/dist-cjs/commands/UpdateUserPoolClientCommand.js +4 -4
  100. package/dist-cjs/commands/UpdateUserPoolCommand.js +4 -4
  101. package/dist-cjs/commands/UpdateUserPoolDomainCommand.js +4 -4
  102. package/dist-cjs/commands/VerifySoftwareTokenCommand.js +4 -4
  103. package/dist-cjs/commands/VerifyUserAttributeCommand.js +3 -3
  104. package/dist-cjs/endpoints.js +1 -1
  105. package/dist-cjs/protocols/Aws_json1_1.js +447 -448
  106. package/dist-cjs/runtimeConfig.browser.js +4 -4
  107. package/dist-cjs/runtimeConfig.js +9 -9
  108. package/dist-cjs/runtimeConfig.native.js +1 -1
  109. package/dist-es/CognitoIdentityProvider.js +101 -101
  110. package/dist-es/pagination/AdminListGroupsForUserPaginator.js +4 -4
  111. package/dist-es/pagination/AdminListUserAuthEventsPaginator.js +4 -4
  112. package/dist-es/pagination/ListGroupsPaginator.js +4 -4
  113. package/dist-es/pagination/ListIdentityProvidersPaginator.js +4 -4
  114. package/dist-es/pagination/ListResourceServersPaginator.js +4 -4
  115. package/dist-es/pagination/ListUserPoolClientsPaginator.js +4 -4
  116. package/dist-es/pagination/ListUserPoolsPaginator.js +4 -4
  117. package/dist-es/pagination/ListUsersInGroupPaginator.js +4 -4
  118. package/dist-es/pagination/ListUsersPaginator.js +4 -4
  119. package/dist-es/protocols/Aws_json1_1.js +7 -10
  120. package/dist-types/CognitoIdentityProvider.d.ts +261 -250
  121. package/dist-types/CognitoIdentityProviderClient.d.ts +2 -2
  122. package/dist-types/commands/AdminCreateUserCommand.d.ts +18 -16
  123. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +7 -4
  124. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +17 -16
  125. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +17 -17
  126. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +17 -16
  127. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +17 -16
  128. package/dist-types/commands/CreateUserPoolCommand.d.ts +17 -17
  129. package/dist-types/commands/ForgotPasswordCommand.d.ts +17 -17
  130. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +17 -17
  131. package/dist-types/commands/InitiateAuthCommand.d.ts +17 -16
  132. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +17 -17
  133. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +17 -16
  134. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -14
  135. package/dist-types/commands/SignUpCommand.d.ts +17 -17
  136. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +17 -17
  137. package/dist-types/commands/UpdateUserPoolCommand.d.ts +17 -17
  138. package/dist-types/models/models_0.d.ts +352 -213
  139. package/dist-types/models/models_1.d.ts +21 -12
  140. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  141. package/dist-types/runtimeConfig.d.ts +1 -1
  142. package/dist-types/runtimeConfig.native.d.ts +3 -3
  143. package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +2 -2
  144. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  145. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  146. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  147. package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
  148. package/package.json +34 -34
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
5
5
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
6
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
7
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
9
  import { AddCustomAttributesCommandInput, AddCustomAttributesCommandOutput } from "./commands/AddCustomAttributesCommand";
10
10
  import { AdminAddUserToGroupCommandInput, AdminAddUserToGroupCommandOutput } from "./commands/AdminAddUserToGroupCommand";
11
11
  import { AdminConfirmSignUpCommandInput, AdminConfirmSignUpCommandOutput } from "./commands/AdminConfirmSignUpCommand";
@@ -129,7 +129,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
129
129
  * A function that can calculate the length of a request body.
130
130
  * @internal
131
131
  */
132
- bodyLengthChecker?: (body: any) => number | undefined;
132
+ bodyLengthChecker?: __BodyLengthCalculator;
133
133
  /**
134
134
  * A function that converts a stream into an array of bytes.
135
135
  * @internal
@@ -11,22 +11,24 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
11
11
  * <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p>
12
12
  *
13
13
  *
14
- * <note>
15
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
16
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
17
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
18
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
19
- * or sign in.</p>
20
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
21
- * might place your account in SMS sandbox. In
22
- * <i>
23
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
24
- * </i>, you will have
25
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
26
- * out of the SMS sandbox and into production. For more information, see
27
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
28
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
29
- * </note>
14
+ *
15
+ * <note>
16
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
17
+ * require you to register an origination phone number before you can send SMS messages
18
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
19
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
20
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
21
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
22
+ * in.</p>
23
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
24
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
25
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
26
+ * mode</a>
27
+ * </i>, you can send messages only to verified phone
28
+ * numbers. After you test your app while in the sandbox environment, you can move out
29
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
30
+ * Developer Guide</i>.</p>
31
+ * </note>
30
32
  *
31
33
  * <p>This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for
32
34
  * user name and temporary password.</p>
@@ -7,10 +7,13 @@ export interface AdminDisableProviderForUserCommandInput extends AdminDisablePro
7
7
  export interface AdminDisableProviderForUserCommandOutput extends AdminDisableProviderForUserResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Amazon Cognito User Pools native username + password user,
11
- * they aren't permitted to use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing
12
- * user is removed. The next time the external user (no longer attached to the previously linked <code>DestinationUser</code>) signs in, they must create a new user account.
13
- * See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
10
+ * <p>Prevents the user from signing in with the specified external (SAML or social)
11
+ * identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native
12
+ * username + password user, they can't use their password to sign in. If the user to
13
+ * deactivate is a linked external identity provider (IdP) user, any link between that user
14
+ * and an existing user is removed. When the external user signs in again, and the user is
15
+ * no longer attached to the previously linked <code>DestinationUser</code>, the user must
16
+ * create a new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
14
17
  * <p>This action is enabled only for admin access and requires developer credentials.</p>
15
18
  * <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p>
16
19
  * <p>To deactivate a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>.
@@ -10,22 +10,23 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
10
10
  * <p>Initiates the authentication flow, as an administrator.</p>
11
11
  *
12
12
  *
13
- * <note>
14
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
15
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
16
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
17
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
18
- * or sign in.</p>
19
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
20
- * might place your account in SMS sandbox. In
21
- * <i>
22
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
23
- * </i>, you will have
24
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
25
- * out of the SMS sandbox and into production. For more information, see
26
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
27
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
28
- * </note>
13
+ * <note>
14
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
15
+ * require you to register an origination phone number before you can send SMS messages
16
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
17
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
18
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
19
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
20
+ * in.</p>
21
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
22
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
23
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
24
+ * mode</a>
25
+ * </i>, you can send messages only to verified phone
26
+ * numbers. After you test your app while in the sandbox environment, you can move out
27
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
28
+ * Developer Guide</i>.</p>
29
+ * </note>
29
30
  *
30
31
  * <p>Calling this action requires developer credentials.</p>
31
32
  * @example
@@ -14,23 +14,23 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
14
14
  * email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user
15
15
  * with the code to change their password.</p>
16
16
  *
17
- *
18
- * <note>
19
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
20
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
21
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
22
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
23
- * or sign in.</p>
24
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
25
- * might place your account in SMS sandbox. In
26
- * <i>
27
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
28
- * </i>, you will have
29
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
30
- * out of the SMS sandbox and into production. For more information, see
31
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
32
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
33
- * </note>
17
+ * <note>
18
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
19
+ * require you to register an origination phone number before you can send SMS messages
20
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
21
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
22
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
23
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
24
+ * in.</p>
25
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
26
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
27
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
28
+ * mode</a>
29
+ * </i>, you can send messages only to verified phone
30
+ * numbers. After you test your app while in the sandbox environment, you can move out
31
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
32
+ * Developer Guide</i>.</p>
33
+ * </note>
34
34
  *
35
35
  * <p>Calling this action requires developer credentials.</p>
36
36
  * @example
@@ -9,22 +9,23 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
9
9
  /**
10
10
  * <p>Responds to an authentication challenge, as an administrator.</p>
11
11
  *
12
- * <note>
13
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
14
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
15
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
16
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
17
- * or sign in.</p>
18
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
19
- * might place your account in SMS sandbox. In
20
- * <i>
21
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
22
- * </i>, you will have
23
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
24
- * out of the SMS sandbox and into production. For more information, see
25
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
26
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
27
- * </note>
12
+ * <note>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
28
+ * </note>
28
29
  *
29
30
  * <p>Calling this action requires developer credentials.</p>
30
31
  * @example
@@ -11,22 +11,23 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
11
11
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
12
12
  * <p>In addition to updating user attributes, this API can also be used to mark phone and email as verified.</p>
13
13
  *
14
- * <note>
15
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
16
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
17
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
18
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
19
- * or sign in.</p>
20
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
21
- * might place your account in SMS sandbox. In
22
- * <i>
23
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
24
- * </i>, you will have
25
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
26
- * out of the SMS sandbox and into production. For more information, see
27
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
28
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
29
- * </note>
14
+ * <note>
15
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
16
+ * require you to register an origination phone number before you can send SMS messages
17
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
18
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
19
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
20
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
21
+ * in.</p>
22
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
23
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
24
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
25
+ * mode</a>
26
+ * </i>, you can send messages only to verified phone
27
+ * numbers. After you test your app while in the sandbox environment, you can move out
28
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
29
+ * Developer Guide</i>.</p>
30
+ * </note>
30
31
  *
31
32
  * <p>Calling this action requires developer credentials.</p>
32
33
  * @example
@@ -9,23 +9,23 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
9
9
  /**
10
10
  * <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p>
11
11
  *
12
- *
13
- * <note>
14
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
15
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
16
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
17
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
18
- * or sign in.</p>
19
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
20
- * might place your account in SMS sandbox. In
21
- * <i>
22
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
23
- * </i>, you will have
24
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
25
- * out of the SMS sandbox and into production. For more information, see
26
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
27
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
28
- * </note>
12
+ * <note>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
28
+ * </note>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -16,23 +16,23 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
16
16
  * call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>.
17
17
  * </p>
18
18
  *
19
- *
20
- * <note>
21
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
22
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
23
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
24
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
25
- * or sign in.</p>
26
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
27
- * might place your account in SMS sandbox. In
28
- * <i>
29
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
30
- * </i>, you will have
31
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
32
- * out of the SMS sandbox and into production. For more information, see
33
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
34
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
35
- * </note>
19
+ * <note>
20
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
21
+ * require you to register an origination phone number before you can send SMS messages
22
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
23
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
24
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
25
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
26
+ * in.</p>
27
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
28
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
29
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
30
+ * mode</a>
31
+ * </i>, you can send messages only to verified phone
32
+ * numbers. After you test your app while in the sandbox environment, you can move out
33
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
34
+ * Developer Guide</i>.</p>
35
+ * </note>
36
36
  * @example
37
37
  * Use a bare-bones client and the command you need to make an API call.
38
38
  * ```javascript
@@ -9,23 +9,23 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
9
9
  /**
10
10
  * <p>Gets the user attribute verification code for the specified attribute name.</p>
11
11
  *
12
- *
13
- * <note>
14
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
15
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
16
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
17
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
18
- * or sign in.</p>
19
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
20
- * might place your account in SMS sandbox. In
21
- * <i>
22
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
23
- * </i>, you will have
24
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
25
- * out of the SMS sandbox and into production. For more information, see
26
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
27
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
28
- * </note>
12
+ * <note>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
28
+ * </note>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -9,22 +9,23 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
9
9
  /**
10
10
  * <p>Initiates the authentication flow.</p>
11
11
  *
12
- * <note>
13
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
14
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
15
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
16
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
17
- * or sign in.</p>
18
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
19
- * might place your account in SMS sandbox. In
20
- * <i>
21
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
22
- * </i>, you will have
23
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
24
- * out of the SMS sandbox and into production. For more information, see
25
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
26
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
27
- * </note>
12
+ * <note>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
28
+ * </note>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
30
31
  * ```javascript
@@ -9,23 +9,23 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
9
9
  /**
10
10
  * <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p>
11
11
  *
12
- *
13
- * <note>
14
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
15
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
16
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
17
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
18
- * or sign in.</p>
19
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
20
- * might place your account in SMS sandbox. In
21
- * <i>
22
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
23
- * </i>, you will have
24
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
25
- * out of the SMS sandbox and into production. For more information, see
26
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
27
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
28
- * </note>
12
+ * <note>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
28
+ * </note>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -9,22 +9,23 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
9
9
  /**
10
10
  * <p>Responds to the authentication challenge.</p>
11
11
  *
12
- * <note>
13
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
14
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
15
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
16
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
17
- * or sign in.</p>
18
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
19
- * might place your account in SMS sandbox. In
20
- * <i>
21
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
22
- * </i>, you will have
23
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
24
- * out of the SMS sandbox and into production. For more information, see
25
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
26
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
27
- * </note>
12
+ * <note>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
28
+ * </note>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
30
31
  * ```javascript
@@ -10,20 +10,21 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
10
10
  * <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
11
11
  *
12
12
  * <note>
13
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
14
- * origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
15
- * register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
16
- * automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
17
- * or sign in.</p>
18
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
19
- * might place your account in SMS sandbox. In
20
- * <i>
21
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
22
- * </i>, you will have
23
- * limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
24
- * out of the SMS sandbox and into production. For more information, see
25
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
26
- * message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
13
+ * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
14
+ * require you to register an origination phone number before you can send SMS messages
15
+ * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
16
+ * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
17
+ * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
18
+ * receive SMS messages might not be able to sign up, activate their accounts, or sign
19
+ * in.</p>
20
+ * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
21
+ * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
22
+ * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
23
+ * mode</a>
24
+ * </i>, you can send messages only to verified phone
25
+ * numbers. After you test your app while in the sandbox environment, you can move out
26
+ * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
27
+ * Developer Guide</i>.</p>
27
28
  * </note>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.