@aws-sdk/client-cognito-identity-provider 3.47.2 → 3.51.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/CHANGELOG.md +35 -0
- package/README.md +3 -7
- package/dist-types/CognitoIdentityProvider.d.ts +367 -457
- package/dist-types/CognitoIdentityProviderClient.d.ts +3 -7
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +20 -23
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +1 -2
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +14 -28
- package/dist-types/commands/AdminGetUserCommand.d.ts +1 -2
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +14 -14
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +12 -19
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +1 -2
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +20 -24
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +14 -14
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +3 -5
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +5 -10
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +3 -3
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +2 -3
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +17 -20
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +2 -3
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +6 -10
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +1 -2
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +1 -2
- package/dist-types/commands/CreateResourceServerCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +16 -16
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +1 -2
- package/dist-types/commands/ForgotPasswordCommand.d.ts +23 -22
- package/dist-types/commands/GetCSVHeaderCommand.d.ts +1 -2
- package/dist-types/commands/GetUICustomizationCommand.d.ts +2 -4
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +15 -14
- package/dist-types/commands/GlobalSignOutCommand.d.ts +2 -3
- package/dist-types/commands/InitiateAuthCommand.d.ts +14 -14
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
- package/dist-types/commands/ListUserPoolsCommand.d.ts +1 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +16 -16
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +14 -14
- package/dist-types/commands/RevokeTokenCommand.d.ts +1 -2
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +2 -5
- package/dist-types/commands/SetUICustomizationCommand.d.ts +7 -12
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +6 -9
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +17 -17
- package/dist-types/commands/SetUserSettingsCommand.d.ts +2 -3
- package/dist-types/commands/SignUpCommand.d.ts +16 -16
- package/dist-types/commands/TagResourceCommand.d.ts +7 -14
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +2 -3
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +3 -4
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +15 -14
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +7 -8
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +18 -17
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +11 -20
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +2 -3
- package/dist-types/models/models_0.d.ts +1409 -2027
- package/dist-types/models/models_1.d.ts +125 -192
- package/package.json +39 -33
|
@@ -7,24 +7,24 @@ export interface CreateUserPoolCommandInput extends CreateUserPoolRequest {
|
|
|
7
7
|
export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the
|
|
11
|
-
*
|
|
10
|
+
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p>
|
|
11
|
+
*
|
|
12
12
|
*
|
|
13
13
|
* <note>
|
|
14
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* in
|
|
21
|
-
*
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
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
28
|
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,8 +7,7 @@ export interface DescribeUserPoolClientCommandInput extends DescribeUserPoolClie
|
|
|
7
7
|
export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolClientResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Client method for returning the configuration information and metadata of the
|
|
11
|
-
* specified user pool app client.</p>
|
|
10
|
+
* <p>Client method for returning the configuration information and metadata of the specified user pool app client.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,30 +7,31 @@ export interface ForgotPasswordCommandInput extends ForgotPasswordRequest {
|
|
|
7
7
|
export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Calling this API causes a message to be sent to the end user with a confirmation code
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
10
|
+
* <p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the
|
|
11
|
+
* <code>Username</code> parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the
|
|
12
|
+
* specified AccountRecoverySetting. For more information,
|
|
13
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering User Accounts</a>
|
|
14
|
+
* in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists,
|
|
15
|
+
* an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password,
|
|
16
|
+
* call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>.
|
|
17
|
+
* </p>
|
|
18
|
+
*
|
|
18
19
|
*
|
|
19
20
|
* <note>
|
|
20
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* in
|
|
27
|
-
*
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
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>
|
|
34
35
|
* </note>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,8 +7,7 @@ export interface GetCSVHeaderCommandInput extends GetCSVHeaderRequest {
|
|
|
7
7
|
export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets the header information for the
|
|
11
|
-
* job.</p>
|
|
10
|
+
* <p>Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,10 +7,8 @@ export interface GetUICustomizationCommandInput extends GetUICustomizationReques
|
|
|
7
7
|
export interface GetUICustomizationCommandOutput extends GetUICustomizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets the UI Customization information for a particular app client's app UI, if
|
|
11
|
-
*
|
|
12
|
-
* pool level customization (app <code>clientId</code> will be <code>ALL</code>), then that
|
|
13
|
-
* is returned. If nothing is present, then an empty shape is returned.</p>
|
|
10
|
+
* <p>Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client,
|
|
11
|
+
* but there is an existing pool level customization (the app <code>clientId</code> is <code>ALL</code>), then that information is returned. If nothing is present, then an empty shape is returned.</p>
|
|
14
12
|
* @example
|
|
15
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
14
|
* ```javascript
|
|
@@ -9,21 +9,22 @@ 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
|
+
*
|
|
12
13
|
* <note>
|
|
13
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* in
|
|
20
|
-
*
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
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>
|
|
27
28
|
* </note>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,9 +7,8 @@ export interface GlobalSignOutCommandInput extends GlobalSignOutRequest {
|
|
|
7
7
|
export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Signs out users from all devices. It also invalidates all refresh tokens issued to a
|
|
11
|
-
*
|
|
12
|
-
* and Id tokens expire one hour after they are issued.</p>
|
|
10
|
+
* <p>Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and ID tokens remain valid until their expiry. Access and Id tokens expire
|
|
11
|
+
* one hour after they're issued.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
14
|
* ```javascript
|
|
@@ -10,20 +10,20 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
|
|
|
10
10
|
* <p>Initiates the authentication flow.</p>
|
|
11
11
|
*
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* in
|
|
20
|
-
*
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
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
27
|
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,8 +8,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
|
|
11
|
-
* <p>A tag is a label that you can apply to user pools to categorize and manage them in
|
|
12
|
-
* different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
11
|
+
* <p>A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
13
12
|
* <p>You can use this action up to 10 times per second, per account.</p>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface ListUserPoolsCommandInput extends ListUserPoolsRequest {
|
|
|
7
7
|
export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the user pools associated with an account.</p>
|
|
10
|
+
* <p>Lists the user pools associated with an Amazon Web Services account.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,24 +7,24 @@ export interface ResendConfirmationCodeCommandInput extends ResendConfirmationCo
|
|
|
7
7
|
export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationCodeResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the
|
|
11
|
-
*
|
|
10
|
+
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p>
|
|
11
|
+
*
|
|
12
12
|
*
|
|
13
13
|
* <note>
|
|
14
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* in
|
|
21
|
-
*
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
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
28
|
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,20 +10,20 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
|
|
|
10
10
|
* <p>Responds to the authentication challenge.</p>
|
|
11
11
|
*
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* in
|
|
20
|
-
*
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
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
27
|
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,8 +7,7 @@ export interface RevokeTokenCommandInput extends RevokeTokenRequest {
|
|
|
7
7
|
export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can
|
|
11
|
-
* use the revoked token to access Cognito authenticated APIs.</p>
|
|
10
|
+
* <p>Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,11 +7,8 @@ export interface SetRiskConfigurationCommandInput extends SetRiskConfigurationRe
|
|
|
7
7
|
export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Configures actions on detected risks. To delete the risk configuration for
|
|
11
|
-
*
|
|
12
|
-
* configuration types.</p>
|
|
13
|
-
* <p>To enable Amazon Cognito advanced security features, update the user pool to include
|
|
14
|
-
* the <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
|
|
10
|
+
* <p>Configures actions on detected risks. To delete the risk configuration for <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four configuration types.</p>
|
|
11
|
+
* <p>To activate Amazon Cognito advanced security features, update the user pool to include the <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
|
|
15
12
|
* @example
|
|
16
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
14
|
* ```javascript
|
|
@@ -7,18 +7,13 @@ export interface SetUICustomizationCommandInput extends SetUICustomizationReques
|
|
|
7
7
|
export interface SetUICustomizationCommandOutput extends SetUICustomizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Sets the UI customization information for a user pool's built-in app UI.</p>
|
|
11
|
-
* <p>You can specify app UI customization settings for a single client (with a specific
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* <note>
|
|
18
|
-
* <p>To use this API, your user pool must have a domain associated with it. Otherwise,
|
|
19
|
-
* there is no place to host the app's pages, and the service will throw an
|
|
20
|
-
* error.</p>
|
|
21
|
-
* </note>
|
|
10
|
+
* <p>Sets the user interface (UI) customization information for a user pool's built-in app UI.</p>
|
|
11
|
+
* <p>You can specify app UI customization settings for a single client (with a specific <code>clientId</code>) or for all clients (by setting the <code>clientId</code>
|
|
12
|
+
* to <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is used for every client that has no previously set UI customization. If you specify UI
|
|
13
|
+
* customization settings for a particular client, it will no longer return to the <code>ALL</code> configuration.</p>
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.</p>
|
|
16
|
+
* </note>
|
|
22
17
|
* @example
|
|
23
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
19
|
* ```javascript
|
|
@@ -7,15 +7,12 @@ export interface SetUserMFAPreferenceCommandInput extends SetUserMFAPreferenceRe
|
|
|
7
7
|
export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Set the user's multi-factor authentication (MFA) method preference, including which
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* unless device tracking is turned on and the device has been trusted. If you would like
|
|
17
|
-
* MFA to be applied selectively based on the assessed risk level of sign in attempts,
|
|
18
|
-
* disable MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
10
|
+
* <p>Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.
|
|
11
|
+
* Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated.
|
|
12
|
+
* If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an
|
|
13
|
+
* MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and
|
|
14
|
+
* the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate
|
|
15
|
+
* MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
19
16
|
* @example
|
|
20
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
18
|
* ```javascript
|
|
@@ -7,24 +7,24 @@ export interface SetUserPoolMfaConfigCommandInput extends SetUserPoolMfaConfigRe
|
|
|
7
7
|
export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
|
|
11
11
|
*
|
|
12
|
-
*
|
|
13
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
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>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -8,9 +8,8 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>
|
|
11
|
-
* <i>This action is no longer supported.</i> You can use it to configure
|
|
12
|
-
*
|
|
13
|
-
* type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
|
|
11
|
+
* <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA.
|
|
12
|
+
* 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>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
15
|
* ```javascript
|
|
@@ -7,24 +7,24 @@ export interface SignUpCommandInput extends SignUpRequest {
|
|
|
7
7
|
export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers the user in the specified user pool and creates a user name, password, and
|
|
11
|
-
*
|
|
10
|
+
* <p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p>
|
|
11
|
+
*
|
|
12
12
|
*
|
|
13
13
|
* <note>
|
|
14
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* in
|
|
21
|
-
*
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
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
28
|
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,20 +7,13 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
7
7
|
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* user pool and <code>Production</code> for the other.</p>
|
|
18
|
-
* <p>Tags are useful for cost tracking and access control. You can activate your tags so
|
|
19
|
-
* that they appear on the Billing and Cost Management console, where you can track the
|
|
20
|
-
* costs associated with your user pools. In an IAM policy, you can constrain permissions
|
|
21
|
-
* for user pools based on specific tags or tag values.</p>
|
|
22
|
-
* <p>You can use this action up to 5 times per second, per account. A user pool can have as
|
|
23
|
-
* many as 50 tags.</p>
|
|
10
|
+
* <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
11
|
+
* <p>Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool,
|
|
12
|
+
* one for testing and another for production, you might assign an <code>Environment</code> tag key to both user pools. The value of this key might be <code>Test</code> for
|
|
13
|
+
* one user pool, and <code>Production</code> for the other.</p>
|
|
14
|
+
* <p>Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with
|
|
15
|
+
* your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.</p>
|
|
16
|
+
* <p>You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.</p>
|
|
24
17
|
* @example
|
|
25
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
19
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
7
7
|
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action
|
|
11
|
-
* up to 5 times per second, per account</p>
|
|
10
|
+
* <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|