|
2102 | 2102 | "UserAttributes": { |
2103 | 2103 | "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", |
2104 | 2104 | "traits": { |
2105 | | - "smithy.api#documentation": "<p>An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than <code>Username</code>. However, any attributes that you specify as required\n (when creating a user pool or in the <b>Attributes</b> tab of\n the console) either you should supply (in your call to <code>AdminCreateUser</code>) or\n the user should supply (when they sign up in response to your welcome message).</p>\n <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the\n attribute name.</p>\n <p>To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. You can do this in your call to AdminCreateUser or in the\n <b>Users</b> tab of the Amazon Cognito console for managing your\n user pools.</p>\n <p>You must also provide an email address or phone number when you expect the user to do\n passwordless sign-in with an email or SMS OTP. These attributes must be provided when\n passwordless options are the only available, or when you don't submit a\n <code>TemporaryPassword</code>.</p>\n <p>In your <code>AdminCreateUser</code> request, you can set the\n <code>email_verified</code> and <code>phone_number_verified</code> attributes to\n <code>true</code>. The following conditions apply:</p>\n <dl>\n <dt>email</dt>\n <dd>\n <p>The email address where you want the user to receive their confirmation\n code and username. You must provide a value for the <code>email</code> when\n you want to set <code>email_verified</code> to <code>true</code>, or if you\n set <code>EMAIL</code> in the <code>DesiredDeliveryMediums</code>\n parameter.</p>\n </dd>\n <dt>phone_number</dt>\n <dd>\n <p>The phone number where you want the user to receive their confirmation\n code and username. You must provide a value for the <code>email</code> when\n you want to set <code>phone_number</code> to <code>true</code>, or if you\n set <code>SMS</code> in the <code>DesiredDeliveryMediums</code>\n parameter.</p>\n </dd>\n </dl>" |
| 2105 | + "smithy.api#documentation": "<p>An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than <code>Username</code>. However, any attributes that you specify as required\n (when creating a user pool or in the <b>Attributes</b> tab of\n the console) either you should supply (in your call to <code>AdminCreateUser</code>) or\n the user should supply (when they sign up in response to your welcome message).</p>\n <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the\n attribute name.</p>\n <p>To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. You can do this in your call to AdminCreateUser or in the\n <b>Users</b> tab of the Amazon Cognito console for managing your\n user pools.</p>\n <p>You must also provide an email address or phone number when you expect the user to do\n passwordless sign-in with an email or SMS OTP. These attributes must be provided when\n passwordless options are the only available, or when you don't submit a\n <code>TemporaryPassword</code>.</p>\n <p>In your <code>AdminCreateUser</code> request, you can set the\n <code>email_verified</code> and <code>phone_number_verified</code> attributes to\n <code>true</code>. The following conditions apply:</p>\n <dl>\n <dt>email</dt>\n <dd>\n <p>The email address where you want the user to receive their confirmation\n code and username. You must provide a value for <code>email</code> when you\n want to set <code>email_verified</code> to <code>true</code>, or if you set\n <code>EMAIL</code> in the <code>DesiredDeliveryMediums</code>\n parameter.</p>\n </dd>\n <dt>phone_number</dt>\n <dd>\n <p>The phone number where you want the user to receive their confirmation\n code and username. You must provide a value for <code>phone_number</code>\n when you want to set <code>phone_number_verified</code> to\n <code>true</code>, or if you set <code>SMS</code> in the\n <code>DesiredDeliveryMediums</code> parameter.</p>\n </dd>\n </dl>" |
2106 | 2106 | } |
2107 | 2107 | }, |
2108 | 2108 | "ValidationData": { |
|
3632 | 3632 | "SoftwareTokenMfaSettings": { |
3633 | 3633 | "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", |
3634 | 3634 | "traits": { |
3635 | | - "smithy.api#documentation": "<p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates\n TOTP MFA and sets it as the preferred MFA method when multiple methods are\n available.</p>" |
| 3635 | + "smithy.api#documentation": "<p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates\n TOTP MFA and sets it as the preferred MFA method when multiple methods are available.\n This operation can set TOTP as a user's preferred MFA method before they register a\n TOTP authenticator.</p>" |
3636 | 3636 | } |
3637 | 3637 | }, |
3638 | 3638 | "EmailMfaSettings": { |
|
7301 | 7301 | "CustomDomainConfig": { |
7302 | 7302 | "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", |
7303 | 7303 | "traits": { |
7304 | | - "smithy.api#documentation": "<p>The configuration for a custom domain. Configures your domain with an Certificate Manager\n certificate in the <code>us-east-1</code> Region.</p>\n <p>Provide this parameter only if you want to use a <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html\">custom domain</a> for your user pool. Otherwise, you can\n omit this parameter and use a <a href=\"cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html\">prefix domain</a> instead.</p>\n <p>When you create a custom domain, the passkey RP ID defaults to the custom domain. If\n you had a prefix domain active, this will cause passkey integration for your prefix\n domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey\n integration working, you can explicitly set RP ID to the prefix domain.</p>" |
| 7304 | + "smithy.api#documentation": "<p>The configuration for a custom domain. Configures your domain with an Certificate Manager\n certificate in the <code>us-east-1</code> Region.</p>\n <p>Provide this parameter only if you want to use a <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html\">custom domain</a> for your user pool. Otherwise, you can\n omit this parameter and use a <a href=\" https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html\">prefix domain</a> instead.</p>\n <p>When you create a custom domain, the passkey RP ID defaults to the custom domain. If\n you had a prefix domain active, this will cause passkey integration for your prefix\n domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey\n integration working, you can explicitly set RP ID to the prefix domain.</p>" |
7305 | 7305 | } |
7306 | 7306 | } |
7307 | 7307 | }, |
|
7420 | 7420 | "DeviceConfiguration": { |
7421 | 7421 | "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", |
7422 | 7422 | "traits": { |
7423 | | - "smithy.api#documentation": "<p>The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html\">Working with user devices in your user pool</a>. A null value indicates that\n 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\n activate the Amazon Cognito device-remembering feature. For more infor</p>\n </note>" |
| 7423 | + "smithy.api#documentation": "<p>The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html\">Working with user devices in your user pool</a>. A null value indicates that\n 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\n activate the Amazon Cognito device-remembering feature. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html\">Working with devices</a>.</p>\n </note>" |
7424 | 7424 | } |
7425 | 7425 | }, |
7426 | 7426 | "EmailConfiguration": { |
|
7980 | 7980 | } |
7981 | 7981 | ], |
7982 | 7982 | "traits": { |
7983 | | - "smithy.api#documentation": "<p>Deletes a user pool. After you delete a user pool, users can no longer sign in to any\n associated applications. </p>\n <p>When you delete a user pool, it's no longer visible or operational in your Amazon Web Services account. Amazon Cognito retains deleted user pools in an inactive state for 14\n days, then begins a cleanup process that fully removes them from Amazon Web Services systems. In case\n of accidental deletion, contact Amazon Web Services Support within 14 days for restoration\n assistance.</p>\n <p>Amazon Cognito begins full deletion of all resources from deleted user pools after 14 days. In\n the case of large user pools, the cleanup process might take significant additional time\n before all user data is permanently deleted.</p>" |
| 7983 | + "smithy.api#documentation": "<p>Deletes a user pool. After you delete a user pool, users can no longer sign in to any\n associated applications. </p>\n <p>When you delete a user pool, it's no longer visible or operational in your Amazon Web Services account. Amazon Cognito retains deleted user pools in an inactive state for 14\n days, then begins a cleanup process that fully removes them from Amazon Web Services systems. In case\n of accidental deletion, contact Amazon Web ServicesSupport within 14 days for restoration\n assistance.</p>\n <p>Amazon Cognito begins full deletion of all resources from deleted user pools after 14 days. In\n the case of large user pools, the cleanup process might take significant additional time\n before all user data is permanently deleted.</p>" |
7984 | 7984 | } |
7985 | 7985 | }, |
7986 | 7986 | "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClient": { |
|
14210 | 14210 | } |
14211 | 14211 | ], |
14212 | 14212 | "traits": { |
14213 | | - "smithy.api#documentation": "<p>Sets up or modifies the logging configuration of a user pool. User pools can export\n user notification logs and, when threat protection is active, user-activity logs. For\n more information, see <a href=\"cognito/latest/developerguide/exporting-quotas-and-usage.html\">Exporting user\n pool logs</a>.</p>" |
| 14213 | + "smithy.api#documentation": "<p>Sets up or modifies the logging configuration of a user pool. User pools can export\n user notification logs and, when threat protection is active, user-activity logs. For\n more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html\">Exporting user\n pool logs</a>.</p>" |
14214 | 14214 | } |
14215 | 14215 | }, |
14216 | 14216 | "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationRequest": { |
|
14470 | 14470 | "SoftwareTokenMfaSettings": { |
14471 | 14471 | "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", |
14472 | 14472 | "traits": { |
14473 | | - "smithy.api#documentation": "<p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates\n TOTP MFA and sets it as the preferred MFA method when multiple methods are\n available.</p>" |
| 14473 | + "smithy.api#documentation": "<p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates\n TOTP MFA and sets it as the preferred MFA method when multiple methods are available.\n Users must register a TOTP authenticator before they set this as their preferred MFA\n method.</p>" |
14474 | 14474 | } |
14475 | 14475 | }, |
14476 | 14476 | "EmailMfaSettings": { |
|
16701 | 16701 | "DeviceConfiguration": { |
16702 | 16702 | "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", |
16703 | 16703 | "traits": { |
16704 | | - "smithy.api#documentation": "<p>The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html\">Working with user devices in your user pool</a>. A null value indicates that\n 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\n activate the Amazon Cognito device-remembering feature. For more infor</p>\n </note>" |
| 16704 | + "smithy.api#documentation": "<p>The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html\">Working with user devices in your user pool</a>. A null value indicates that\n 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\n activate the Amazon Cognito device-remembering feature. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html\">Working with devices</a>.</p>\n </note>" |
16705 | 16705 | } |
16706 | 16706 | }, |
16707 | 16707 | "EmailConfiguration": { |
|
17753 | 17753 | "UserStatus": { |
17754 | 17754 | "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", |
17755 | 17755 | "traits": { |
17756 | | - "smithy.api#documentation": "<p>The user status. This can be one of the following:</p>\n <ul>\n <li>\n <p>UNCONFIRMED - User has been created but not confirmed.</p>\n </li>\n <li>\n <p>CONFIRMED - User has been confirmed.</p>\n </li>\n <li>\n <p>EXTERNAL_PROVIDER - User signed in with a third-party IdP.</p>\n </li>\n <li>\n <p>UNKNOWN - User status isn't known.</p>\n </li>\n <li>\n <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset\n their password before they can sign in.</p>\n </li>\n <li>\n <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a\n temporary password, but on first sign-in, the user must change their password to\n a new value before doing anything else. </p>\n </li>\n </ul>" |
| 17756 | + "smithy.api#documentation": "<p>The user status. This can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>UNCONFIRMED</code>: User has been created but not confirmed.</p>\n </li>\n <li>\n <p>\n <code>CONFIRMED</code>: User has been confirmed.</p>\n </li>\n <li>\n <p>\n <code>EXTERNAL_PROVIDER</code>: User signed in with a third-party IdP.</p>\n </li>\n <li>\n <p>\n <code>RESET_REQUIRED</code>: User is confirmed, but the user must request a\n code and reset their password before they can sign in.</p>\n </li>\n <li>\n <p>\n <code>FORCE_CHANGE_PASSWORD</code>: The user is confirmed and the user can\n sign in using a temporary password, but on first sign-in, the user must change\n their password to a new value before doing anything else. </p>\n </li>\n </ul>\n <p>The statuses <code>ARCHIVED</code>, <code>UNKNOWN</code>, and <code>COMPROMISED</code>\n are no longer used.</p>" |
17757 | 17757 | } |
17758 | 17758 | }, |
17759 | 17759 | "MFAOptions": { |
|
0 commit comments