|
3108 | 3108 | "smithy.api#sensitive": {}
|
3109 | 3109 | }
|
3110 | 3110 | },
|
| 3111 | + "com.amazonaws.cognitoidentityprovider#AuthSessionValidityType": { |
| 3112 | + "type": "integer", |
| 3113 | + "traits": { |
| 3114 | + "smithy.api#box": {}, |
| 3115 | + "smithy.api#range": { |
| 3116 | + "min": 3, |
| 3117 | + "max": 15 |
| 3118 | + } |
| 3119 | + } |
| 3120 | + }, |
3111 | 3121 | "com.amazonaws.cognitoidentityprovider#AuthenticationResultType": {
|
3112 | 3122 | "type": "structure",
|
3113 | 3123 | "members": {
|
|
4535 | 4545 | "EnablePropagateAdditionalUserContextData": {
|
4536 | 4546 | "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType",
|
4537 | 4547 | "traits": {
|
4538 |
| - "smithy.api#documentation": "<p>Activates the propagation of additional user context data. For more information about\n propagation of user context data, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html\"> Adding advanced security to a user pool</a>. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a\n client secret.</p>" |
| 4548 | + "smithy.api#documentation": "<p>Activates the propagation of additional user context data. For more information about\n propagation of user context data, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html\"> Adding advanced security to a user pool</a>. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a\n client secret.</p>" |
| 4549 | + } |
| 4550 | + }, |
| 4551 | + "AuthSessionValidity": { |
| 4552 | + "target": "com.amazonaws.cognitoidentityprovider#AuthSessionValidityType", |
| 4553 | + "traits": { |
| 4554 | + "smithy.api#documentation": "<p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>" |
4539 | 4555 | }
|
4540 | 4556 | }
|
4541 | 4557 | },
|
|
4665 | 4681 | "SmsVerificationMessage": {
|
4666 | 4682 | "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType",
|
4667 | 4683 | "traits": {
|
4668 |
| - "smithy.api#documentation": "<p>A string representing the SMS verification message.</p>" |
| 4684 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
4669 | 4685 | }
|
4670 | 4686 | },
|
4671 | 4687 | "EmailVerificationMessage": {
|
4672 | 4688 | "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType",
|
4673 | 4689 | "traits": {
|
4674 |
| - "smithy.api#documentation": "<p>A string representing the email verification message.\n <code>EmailVerificationMessage</code> is allowed only if <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is DEVELOPER. </p>" |
| 4690 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
4675 | 4691 | }
|
4676 | 4692 | },
|
4677 | 4693 | "EmailVerificationSubject": {
|
4678 | 4694 | "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType",
|
4679 | 4695 | "traits": {
|
4680 |
| - "smithy.api#documentation": "<p>A string representing the email verification subject.\n <code>EmailVerificationSubject</code> is allowed only if <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount\">EmailSendingAccount</a> is DEVELOPER. </p>" |
| 4696 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
4681 | 4697 | }
|
4682 | 4698 | },
|
4683 | 4699 | "VerificationMessageTemplate": {
|
|
5780 | 5796 | "ChallengeRequiredOnNewDevice": {
|
5781 | 5797 | "target": "com.amazonaws.cognitoidentityprovider#BooleanType",
|
5782 | 5798 | "traits": {
|
5783 |
| - "smithy.api#documentation": "<p>When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).</p>\n <note> \n <p>Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.</p>\n </note>" |
| 5799 | + "smithy.api#documentation": "<p>When true, a remembered device can sign in with device authentication instead of SMS\n and time-based one-time password (TOTP) factors for multi-factor authentication\n (MFA).</p>\n <note> \n <p>Whether or not <code>ChallengeRequiredOnNewDevice</code> is true, users who sign in\n with devices that have not been confirmed or remembered must still provide a second\n factor in a user pool that requires MFA.</p>\n </note>" |
5784 | 5800 | }
|
5785 | 5801 | },
|
5786 | 5802 | "DeviceOnlyRememberedOnUserPrompt": {
|
5787 | 5803 | "target": "com.amazonaws.cognitoidentityprovider#BooleanType",
|
5788 | 5804 | "traits": {
|
5789 |
| - "smithy.api#documentation": "<p>When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device \n can instead opt in to remembering their device. To collect a choice from your user, create an input prompt \n in your app and return the value that the user chooses in an <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html\">UpdateDeviceStatus</a> API request.</p>" |
| 5805 | + "smithy.api#documentation": "<p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a\n <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html\">\n ConfirmDevice</a> API request. In your app, create a prompt for\n your user to choose whether they want to remember their device. Return the user's choice\n in an <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html\">\n UpdateDeviceStatus</a> API request.</p>\n <p>When <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>false</code>, Amazon\n Cognito immediately remembers devices that you register in a <code>ConfirmDevice</code>\n API request.</p>" |
5790 | 5806 | }
|
5791 | 5807 | }
|
5792 | 5808 | },
|
5793 | 5809 | "traits": {
|
5794 |
| - "smithy.api#documentation": "<p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p>\n <note> \n <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>\n </note>" |
| 5810 | + "smithy.api#documentation": "<p>The device-remembering configuration for a user pool. A <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html\">\n DescribeUserPool</a> request returns a null value for this object when the user\n pool isn't configured to remember devices. When device remembering is active, you can\n remember a user's device with a <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html\">ConfirmDevice</a> API request. Additionally. when the property\n <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>true</code>, you must follow\n <code>ConfirmDevice</code> with an <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html\">UpdateDeviceStatus</a> API request that sets the user's device to\n <code>remembered</code> or <code>not_remembered</code>.</p>\n <p>To sign in with a remembered device, include <code>DEVICE_KEY</code> in the\n authentication parameters in your user's <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html\">\n InitiateAuth</a> request. If your app doesn't include a <code>DEVICE_KEY</code>\n parameter, the <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax\">response</a> from Amazon Cognito includes newly-generated <code>DEVICE_KEY</code> and\n <code>DEVICE_GROUP_KEY</code> values under <code>NewDeviceMetadata</code>. Store\n these values to use in future device-authentication requests.</p>\n <note> \n <p>When you provide a value for any property of <code>DeviceConfiguration</code>, you\n activate the device remembering for the user pool.</p>\n </note>" |
5795 | 5811 | }
|
5796 | 5812 | },
|
5797 | 5813 | "com.amazonaws.cognitoidentityprovider#DeviceKeyType": {
|
|
12024 | 12040 | "EnablePropagateAdditionalUserContextData": {
|
12025 | 12041 | "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType",
|
12026 | 12042 | "traits": {
|
12027 |
| - "smithy.api#documentation": "<p>Activates the propagation of additional user context data. For more information about\n propagation of user context data, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html\"> Adding advanced security to a user pool</a>. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a\n client secret.</p>" |
| 12043 | + "smithy.api#documentation": "<p>Activates the propagation of additional user context data. For more information about\n propagation of user context data, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html\"> Adding advanced security to a user pool</a>. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a\n client secret.</p>" |
| 12044 | + } |
| 12045 | + }, |
| 12046 | + "AuthSessionValidity": { |
| 12047 | + "target": "com.amazonaws.cognitoidentityprovider#AuthSessionValidityType", |
| 12048 | + "traits": { |
| 12049 | + "smithy.api#documentation": "<p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>" |
12028 | 12050 | }
|
12029 | 12051 | }
|
12030 | 12052 | },
|
@@ -12149,19 +12171,19 @@
|
12149 | 12171 | "SmsVerificationMessage": {
|
12150 | 12172 | "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType",
|
12151 | 12173 | "traits": {
|
12152 |
| - "smithy.api#documentation": "<p>A container with information about the SMS verification message.</p>" |
| 12174 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
12153 | 12175 | }
|
12154 | 12176 | },
|
12155 | 12177 | "EmailVerificationMessage": {
|
12156 | 12178 | "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType",
|
12157 | 12179 | "traits": {
|
12158 |
| - "smithy.api#documentation": "<p>The contents of the email verification message.</p>" |
| 12180 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
12159 | 12181 | }
|
12160 | 12182 | },
|
12161 | 12183 | "EmailVerificationSubject": {
|
12162 | 12184 | "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType",
|
12163 | 12185 | "traits": {
|
12164 |
| - "smithy.api#documentation": "<p>The subject of the email verification message.</p>" |
| 12186 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
12165 | 12187 | }
|
12166 | 12188 | },
|
12167 | 12189 | "VerificationMessageTemplate": {
|
|
12719 | 12741 | "traits": {
|
12720 | 12742 | "smithy.api#documentation": "<p>When <code>EnablePropagateAdditionalUserContextData</code> is true, Amazon Cognito accepts an\n <code>IpAddress</code> value that you send in the <code>UserContextData</code>\n parameter. The <code>UserContextData</code> parameter sends information to Amazon Cognito\n advanced security for risk analysis. You can send <code>UserContextData</code> when you\n sign in Amazon Cognito native users with the <code>InitiateAuth</code> and\n <code>RespondToAuthChallenge</code> API operations.</p>\n <p>When <code>EnablePropagateAdditionalUserContextData</code> is false, you can't send\n your user's source IP address to Amazon Cognito advanced security with unauthenticated API\n operations. <code>EnablePropagateAdditionalUserContextData</code> doesn't affect whether\n you can send a source IP address in a <code>ContextData</code> parameter with the\n authenticated API operations <code>AdminInitiateAuth</code> and\n <code>AdminRespondToAuthChallenge</code>.</p>\n <p>You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app\n client that has a client secret. For more information about propagation of user context\n data, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint\">Adding user device and session data to API requests</a>.</p>"
|
12721 | 12743 | }
|
| 12744 | + }, |
| 12745 | + "AuthSessionValidity": { |
| 12746 | + "target": "com.amazonaws.cognitoidentityprovider#AuthSessionValidityType", |
| 12747 | + "traits": { |
| 12748 | + "smithy.api#documentation": "<p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>" |
| 12749 | + } |
12722 | 12750 | }
|
12723 | 12751 | },
|
12724 | 12752 | "traits": {
|
@@ -12928,19 +12956,19 @@
|
12928 | 12956 | "SmsVerificationMessage": {
|
12929 | 12957 | "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType",
|
12930 | 12958 | "traits": {
|
12931 |
| - "smithy.api#documentation": "<p>The contents of the SMS verification message.</p>" |
| 12959 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
12932 | 12960 | }
|
12933 | 12961 | },
|
12934 | 12962 | "EmailVerificationMessage": {
|
12935 | 12963 | "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType",
|
12936 | 12964 | "traits": {
|
12937 |
| - "smithy.api#documentation": "<p>The contents of the email verification message.</p>" |
| 12965 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
12938 | 12966 | }
|
12939 | 12967 | },
|
12940 | 12968 | "EmailVerificationSubject": {
|
12941 | 12969 | "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType",
|
12942 | 12970 | "traits": {
|
12943 |
| - "smithy.api#documentation": "<p>The subject of the email verification message.</p>" |
| 12971 | + "smithy.api#documentation": "<p>This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>.</p>" |
12944 | 12972 | }
|
12945 | 12973 | },
|
12946 | 12974 | "VerificationMessageTemplate": {
|
|
0 commit comments