aws-sdk-cognitoidentityprovider 1.117.0 → 1.118.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56478444c0af2150f985509932b8570f8913bcb6d9cc67d5993990cb5a5d7464
-  data.tar.gz: 4a71b229862473a214a261d3a8effceb23532ba35b4d19b392f827260b66fea0
+  metadata.gz: ff1ce0bdf772defb37617a546eba136b79a96c242ae67387f21d7f128c6bb3d8
+  data.tar.gz: 0f58e28f3f8a0d7b96a403607ceceaa2c3d85ea58b0affb743bafa6c61f91bae
 SHA512:
-  metadata.gz: f08ecd9fc2ae9d3778ddc84dba8a453bfd0a5fd95414c5d1da23323903206f1ea752dd1b380550b4d3cfb5df4364fab8a2cf28a7715783024630abc0295d995e
-  data.tar.gz: c8123eb204ac0b1fde1273777f9dea15609cc7d6ab6da4c919cf639bd190d4465d185b5be02cccd48e4b3e997614c3b2403a151d65064947efb0c940d0db04b6
+  metadata.gz: 539e2ad805fe2c66b5cb4cf147da155396123d6d200c6918b89abf3de1bce20101dd8f46263eff65a4a388d319ba50b99c5150aeeb4ebfb6ad434ec534c041ce
+  data.tar.gz: d4a749e8187b2c46e0389b1e79205963357fdab8964666c0a06bb96ecd3ef808c08bc5b6080944234fef9b81914990b2dbe7e2fdd94ec3a9f87e69928eea5a16

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.118.0 (2025-03-14)
+------------------
+
+* Feature - Minor description updates to API parameters
+
 1.117.0 (2025-03-03)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.117.0
+1.118.0

data/lib/aws-sdk-cognitoidentityprovider/client.rb

@@ -845,16 +845,17 @@ module Aws::CognitoIdentityProvider
     #   email
     #
     #   : The email address where you want the user to receive their
-    #     confirmation code and username. You must provide a value for the
-    #     `email` when you want to set `email_verified` to `true`, or if you
-    #     set `EMAIL` in the `DesiredDeliveryMediums` parameter.
+    #     confirmation code and username. You must provide a value for `email`
+    #     when you want to set `email_verified` to `true`, or if you set
+    #     `EMAIL` in the `DesiredDeliveryMediums` parameter.
     #
     #   phone\_number
     #
     #   : The phone number where you want the user to receive their
-    #     confirmation code and username. You must provide a value for the
-    #     `email` when you want to set `phone_number` to `true`, or if you set
-    #     `SMS` in the `DesiredDeliveryMediums` parameter.
+    #     confirmation code and username. You must provide a value for
+    #     `phone_number` when you want to set `phone_number_verified` to
+    #     `true`, or if you set `SMS` in the `DesiredDeliveryMediums`
+    #     parameter.
     #
     # @option params [Array<Types::AttributeType>] :validation_data
     #   Temporary user attributes that contribute to the outcomes of your pre
@@ -2868,7 +2869,9 @@ module Aws::CognitoIdentityProvider
     # @option params [Types::SoftwareTokenMfaSettingsType] :software_token_mfa_settings
     #   User preferences for time-based one-time password (TOTP) MFA.
     #   Activates or deactivates TOTP MFA and sets it as the preferred MFA
-    #   method when multiple methods are available.
+    #   method when multiple methods are available. This operation can set
+    #   TOTP as a user's preferred MFA method before they register a TOTP
+    #   authenticator.
     #
     # @option params [Types::EmailMfaSettingsType] :email_mfa_settings
     #   User preferences for email message MFA. Activates or deactivates email
@@ -4712,7 +4715,8 @@ module Aws::CognitoIdentityProvider
     #   you have deactivated device remembering in your user pool.
     #
     #   <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
-    #   activate the Amazon Cognito device-remembering feature. For more infor
+    #   activate the Amazon Cognito device-remembering feature. For more
+    #   information, see [Working with devices][1].
     #
     #    </note>
     #
@@ -6168,9 +6172,7 @@ module Aws::CognitoIdentityProvider
     #
     #   Provide this parameter only if you want to use a [custom domain][1]
     #   for your user pool. Otherwise, you can omit this parameter and use a
-    #   [prefix
-    #   domain](cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html)
-    #   instead.
+    #   [prefix domain][2] instead.
     #
     #   When you create a custom domain, the passkey RP ID defaults to the
     #   custom domain. If you had a prefix domain active, this will cause
@@ -6181,6 +6183,7 @@ module Aws::CognitoIdentityProvider
     #
     #
     #   [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
+    #   [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html
     #
     # @return [Types::CreateUserPoolDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -6508,8 +6511,8 @@ module Aws::CognitoIdentityProvider
     # your Amazon Web Services account. Amazon Cognito retains deleted user
     # pools in an inactive state for 14 days, then begins a cleanup process
     # that fully removes them from Amazon Web Services systems. In case of
-    # accidental deletion, contact Amazon Web Services Support within 14
-    # days for restoration assistance.
+    # accidental deletion, contact Amazon Web ServicesSupport within 14 days
+    # for restoration assistance.
     #
     # Amazon Cognito begins full deletion of all resources from deleted user
     # pools after 14 days. In the case of large user pools, the cleanup
@@ -10096,8 +10099,11 @@ module Aws::CognitoIdentityProvider
     # Sets up or modifies the logging configuration of a user pool. User
     # pools can export user notification logs and, when threat protection is
     # active, user-activity logs. For more information, see [Exporting user
-    # pool
-    # logs](cognito/latest/developerguide/exporting-quotas-and-usage.html).
+    # pool logs][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html
     #
     # @option params [required, String] :user_pool_id
     #   The ID of the user pool where you want to configure logging.
@@ -10417,7 +10423,8 @@ module Aws::CognitoIdentityProvider
     # @option params [Types::SoftwareTokenMfaSettingsType] :software_token_mfa_settings
     #   User preferences for time-based one-time password (TOTP) MFA.
     #   Activates or deactivates TOTP MFA and sets it as the preferred MFA
-    #   method when multiple methods are available.
+    #   method when multiple methods are available. Users must register a TOTP
+    #   authenticator before they set this as their preferred MFA method.
     #
     # @option params [Types::EmailMfaSettingsType] :email_mfa_settings
     #   User preferences for email message MFA. Activates or deactivates email
@@ -11983,7 +11990,8 @@ module Aws::CognitoIdentityProvider
     #   you have deactivated device remembering in your user pool.
     #
     #   <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
-    #   activate the Amazon Cognito device-remembering feature. For more infor
+    #   activate the Amazon Cognito device-remembering feature. For more
+    #   information, see [Working with devices][1].
     #
     #    </note>
     #
@@ -12882,7 +12890,7 @@ module Aws::CognitoIdentityProvider
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
-      context[:gem_version] = '1.117.0'
+      context[:gem_version] = '1.118.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cognitoidentityprovider/types.rb

@@ -385,16 +385,17 @@ module Aws::CognitoIdentityProvider
     #   email
     #
     #   : The email address where you want the user to receive their
-    #     confirmation code and username. You must provide a value for the
+    #     confirmation code and username. You must provide a value for
     #     `email` when you want to set `email_verified` to `true`, or if you
     #     set `EMAIL` in the `DesiredDeliveryMediums` parameter.
     #
     #   phone\_number
     #
     #   : The phone number where you want the user to receive their
-    #     confirmation code and username. You must provide a value for the
-    #     `email` when you want to set `phone_number` to `true`, or if you
-    #     set `SMS` in the `DesiredDeliveryMediums` parameter.
+    #     confirmation code and username. You must provide a value for
+    #     `phone_number` when you want to set `phone_number_verified` to
+    #     `true`, or if you set `SMS` in the `DesiredDeliveryMediums`
+    #     parameter.
     #   @return [Array<Types::AttributeType>]
     #
     # @!attribute [rw] validation_data
@@ -2073,7 +2074,9 @@ module Aws::CognitoIdentityProvider
     # @!attribute [rw] software_token_mfa_settings
     #   User preferences for time-based one-time password (TOTP) MFA.
     #   Activates or deactivates TOTP MFA and sets it as the preferred MFA
-    #   method when multiple methods are available.
+    #   method when multiple methods are available. This operation can set
+    #   TOTP as a user's preferred MFA method before they register a TOTP
+    #   authenticator.
     #   @return [Types::SoftwareTokenMfaSettingsType]
     #
     # @!attribute [rw] email_mfa_settings
@@ -4322,9 +4325,7 @@ module Aws::CognitoIdentityProvider
     #
     #   Provide this parameter only if you want to use a [custom domain][1]
     #   for your user pool. Otherwise, you can omit this parameter and use a
-    #   [prefix
-    #   domain](cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html)
-    #   instead.
+    #   [prefix domain][2] instead.
     #
     #   When you create a custom domain, the passkey RP ID defaults to the
     #   custom domain. If you had a prefix domain active, this will cause
@@ -4335,6 +4336,7 @@ module Aws::CognitoIdentityProvider
     #
     #
     #   [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
+    #   [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html
     #   @return [Types::CustomDomainConfigType]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomainRequest AWS API Documentation
@@ -4507,7 +4509,7 @@ module Aws::CognitoIdentityProvider
     #
     #   <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
     #   activate the Amazon Cognito device-remembering feature. For more
-    #   infor
+    #   information, see [Working with devices][1].
     #
     #    </note>
     #
@@ -9754,7 +9756,9 @@ module Aws::CognitoIdentityProvider
     # @!attribute [rw] software_token_mfa_settings
     #   User preferences for time-based one-time password (TOTP) MFA.
     #   Activates or deactivates TOTP MFA and sets it as the preferred MFA
-    #   method when multiple methods are available.
+    #   method when multiple methods are available. Users must register a
+    #   TOTP authenticator before they set this as their preferred MFA
+    #   method.
     #   @return [Types::SoftwareTokenMfaSettingsType]
     #
     # @!attribute [rw] email_mfa_settings
@@ -11805,7 +11809,7 @@ module Aws::CognitoIdentityProvider
     #
     #   <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
     #   activate the Amazon Cognito device-remembering feature. For more
-    #   infor
+    #   information, see [Working with devices][1].
     #
     #    </note>
     #
@@ -13078,21 +13082,22 @@ module Aws::CognitoIdentityProvider
     # @!attribute [rw] user_status
     #   The user status. This can be one of the following:
     #
-    #   * UNCONFIRMED - User has been created but not confirmed.
+    #   * `UNCONFIRMED`: User has been created but not confirmed.
     #
-    #   * CONFIRMED - User has been confirmed.
+    #   * `CONFIRMED`: User has been confirmed.
     #
-    #   * EXTERNAL\_PROVIDER - User signed in with a third-party IdP.
+    #   * `EXTERNAL_PROVIDER`: User signed in with a third-party IdP.
     #
-    #   * UNKNOWN - User status isn't known.
-    #
-    #   * RESET\_REQUIRED - User is confirmed, but the user must request a
+    #   * `RESET_REQUIRED`: User is confirmed, but the user must request a
     #     code and reset their password before they can sign in.
     #
-    #   * FORCE\_CHANGE\_PASSWORD - The user is confirmed and the user can
+    #   * `FORCE_CHANGE_PASSWORD`: The user is confirmed and the user can
     #     sign in using a temporary password, but on first sign-in, the user
     #     must change their password to a new value before doing anything
     #     else.
+    #
+    #   The statuses `ARCHIVED`, `UNKNOWN`, and `COMPROMISED` are no longer
+    #   used.
     #   @return [String]
     #
     # @!attribute [rw] mfa_options

data/lib/aws-sdk-cognitoidentityprovider.rb

@@ -54,7 +54,7 @@ module Aws::CognitoIdentityProvider
   autoload :EndpointProvider, 'aws-sdk-cognitoidentityprovider/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-cognitoidentityprovider/endpoints'
 
-  GEM_VERSION = '1.117.0'
+  GEM_VERSION = '1.118.0'
 
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cognitoidentityprovider
 version: !ruby/object:Gem::Version
-  version: 1.117.0
+  version: 1.118.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core