aws-sdk-cognitoidentityprovider 1.117.0 → 1.118.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 56478444c0af2150f985509932b8570f8913bcb6d9cc67d5993990cb5a5d7464
4
- data.tar.gz: 4a71b229862473a214a261d3a8effceb23532ba35b4d19b392f827260b66fea0
3
+ metadata.gz: ff1ce0bdf772defb37617a546eba136b79a96c242ae67387f21d7f128c6bb3d8
4
+ data.tar.gz: 0f58e28f3f8a0d7b96a403607ceceaa2c3d85ea58b0affb743bafa6c61f91bae
5
5
  SHA512:
6
- metadata.gz: f08ecd9fc2ae9d3778ddc84dba8a453bfd0a5fd95414c5d1da23323903206f1ea752dd1b380550b4d3cfb5df4364fab8a2cf28a7715783024630abc0295d995e
7
- data.tar.gz: c8123eb204ac0b1fde1273777f9dea15609cc7d6ab6da4c919cf639bd190d4465d185b5be02cccd48e4b3e997614c3b2403a151d65064947efb0c940d0db04b6
6
+ metadata.gz: 539e2ad805fe2c66b5cb4cf147da155396123d6d200c6918b89abf3de1bce20101dd8f46263eff65a4a388d319ba50b99c5150aeeb4ebfb6ad434ec534c041ce
7
+ data.tar.gz: d4a749e8187b2c46e0389b1e79205963357fdab8964666c0a06bb96ecd3ef808c08bc5b6080944234fef9b81914990b2dbe7e2fdd94ec3a9f87e69928eea5a16
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.118.0 (2025-03-14)
5
+ ------------------
6
+
7
+ * Feature - Minor description updates to API parameters
8
+
4
9
  1.117.0 (2025-03-03)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.117.0
1
+ 1.118.0
@@ -845,16 +845,17 @@ module Aws::CognitoIdentityProvider
845
845
  # email
846
846
  #
847
847
  # : The email address where you want the user to receive their
848
- # confirmation code and username. You must provide a value for the
849
- # `email` when you want to set `email_verified` to `true`, or if you
850
- # set `EMAIL` in the `DesiredDeliveryMediums` parameter.
848
+ # confirmation code and username. You must provide a value for `email`
849
+ # when you want to set `email_verified` to `true`, or if you set
850
+ # `EMAIL` in the `DesiredDeliveryMediums` parameter.
851
851
  #
852
852
  # phone\_number
853
853
  #
854
854
  # : The phone number where you want the user to receive their
855
- # confirmation code and username. You must provide a value for the
856
- # `email` when you want to set `phone_number` to `true`, or if you set
857
- # `SMS` in the `DesiredDeliveryMediums` parameter.
855
+ # confirmation code and username. You must provide a value for
856
+ # `phone_number` when you want to set `phone_number_verified` to
857
+ # `true`, or if you set `SMS` in the `DesiredDeliveryMediums`
858
+ # parameter.
858
859
  #
859
860
  # @option params [Array<Types::AttributeType>] :validation_data
860
861
  # Temporary user attributes that contribute to the outcomes of your pre
@@ -2868,7 +2869,9 @@ module Aws::CognitoIdentityProvider
2868
2869
  # @option params [Types::SoftwareTokenMfaSettingsType] :software_token_mfa_settings
2869
2870
  # User preferences for time-based one-time password (TOTP) MFA.
2870
2871
  # Activates or deactivates TOTP MFA and sets it as the preferred MFA
2871
- # method when multiple methods are available.
2872
+ # method when multiple methods are available. This operation can set
2873
+ # TOTP as a user's preferred MFA method before they register a TOTP
2874
+ # authenticator.
2872
2875
  #
2873
2876
  # @option params [Types::EmailMfaSettingsType] :email_mfa_settings
2874
2877
  # User preferences for email message MFA. Activates or deactivates email
@@ -4712,7 +4715,8 @@ module Aws::CognitoIdentityProvider
4712
4715
  # you have deactivated device remembering in your user pool.
4713
4716
  #
4714
4717
  # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
4715
- # activate the Amazon Cognito device-remembering feature. For more infor
4718
+ # activate the Amazon Cognito device-remembering feature. For more
4719
+ # information, see [Working with devices][1].
4716
4720
  #
4717
4721
  # </note>
4718
4722
  #
@@ -6168,9 +6172,7 @@ module Aws::CognitoIdentityProvider
6168
6172
  #
6169
6173
  # Provide this parameter only if you want to use a [custom domain][1]
6170
6174
  # for your user pool. Otherwise, you can omit this parameter and use a
6171
- # [prefix
6172
- # domain](cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html)
6173
- # instead.
6175
+ # [prefix domain][2] instead.
6174
6176
  #
6175
6177
  # When you create a custom domain, the passkey RP ID defaults to the
6176
6178
  # custom domain. If you had a prefix domain active, this will cause
@@ -6181,6 +6183,7 @@ module Aws::CognitoIdentityProvider
6181
6183
  #
6182
6184
  #
6183
6185
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
6186
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html
6184
6187
  #
6185
6188
  # @return [Types::CreateUserPoolDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6186
6189
  #
@@ -6508,8 +6511,8 @@ module Aws::CognitoIdentityProvider
6508
6511
  # your Amazon Web Services account. Amazon Cognito retains deleted user
6509
6512
  # pools in an inactive state for 14 days, then begins a cleanup process
6510
6513
  # that fully removes them from Amazon Web Services systems. In case of
6511
- # accidental deletion, contact Amazon Web Services Support within 14
6512
- # days for restoration assistance.
6514
+ # accidental deletion, contact Amazon Web ServicesSupport within 14 days
6515
+ # for restoration assistance.
6513
6516
  #
6514
6517
  # Amazon Cognito begins full deletion of all resources from deleted user
6515
6518
  # pools after 14 days. In the case of large user pools, the cleanup
@@ -10096,8 +10099,11 @@ module Aws::CognitoIdentityProvider
10096
10099
  # Sets up or modifies the logging configuration of a user pool. User
10097
10100
  # pools can export user notification logs and, when threat protection is
10098
10101
  # active, user-activity logs. For more information, see [Exporting user
10099
- # pool
10100
- # logs](cognito/latest/developerguide/exporting-quotas-and-usage.html).
10102
+ # pool logs][1].
10103
+ #
10104
+ #
10105
+ #
10106
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html
10101
10107
  #
10102
10108
  # @option params [required, String] :user_pool_id
10103
10109
  # The ID of the user pool where you want to configure logging.
@@ -10417,7 +10423,8 @@ module Aws::CognitoIdentityProvider
10417
10423
  # @option params [Types::SoftwareTokenMfaSettingsType] :software_token_mfa_settings
10418
10424
  # User preferences for time-based one-time password (TOTP) MFA.
10419
10425
  # Activates or deactivates TOTP MFA and sets it as the preferred MFA
10420
- # method when multiple methods are available.
10426
+ # method when multiple methods are available. Users must register a TOTP
10427
+ # authenticator before they set this as their preferred MFA method.
10421
10428
  #
10422
10429
  # @option params [Types::EmailMfaSettingsType] :email_mfa_settings
10423
10430
  # User preferences for email message MFA. Activates or deactivates email
@@ -11983,7 +11990,8 @@ module Aws::CognitoIdentityProvider
11983
11990
  # you have deactivated device remembering in your user pool.
11984
11991
  #
11985
11992
  # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
11986
- # activate the Amazon Cognito device-remembering feature. For more infor
11993
+ # activate the Amazon Cognito device-remembering feature. For more
11994
+ # information, see [Working with devices][1].
11987
11995
  #
11988
11996
  # </note>
11989
11997
  #
@@ -12882,7 +12890,7 @@ module Aws::CognitoIdentityProvider
12882
12890
  tracer: tracer
12883
12891
  )
12884
12892
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
12885
- context[:gem_version] = '1.117.0'
12893
+ context[:gem_version] = '1.118.0'
12886
12894
  Seahorse::Client::Request.new(handlers, context)
12887
12895
  end
12888
12896
 
@@ -385,16 +385,17 @@ module Aws::CognitoIdentityProvider
385
385
  # email
386
386
  #
387
387
  # : The email address where you want the user to receive their
388
- # confirmation code and username. You must provide a value for the
388
+ # confirmation code and username. You must provide a value for
389
389
  # `email` when you want to set `email_verified` to `true`, or if you
390
390
  # set `EMAIL` in the `DesiredDeliveryMediums` parameter.
391
391
  #
392
392
  # phone\_number
393
393
  #
394
394
  # : The phone number where you want the user to receive their
395
- # confirmation code and username. You must provide a value for the
396
- # `email` when you want to set `phone_number` to `true`, or if you
397
- # set `SMS` in the `DesiredDeliveryMediums` parameter.
395
+ # confirmation code and username. You must provide a value for
396
+ # `phone_number` when you want to set `phone_number_verified` to
397
+ # `true`, or if you set `SMS` in the `DesiredDeliveryMediums`
398
+ # parameter.
398
399
  # @return [Array<Types::AttributeType>]
399
400
  #
400
401
  # @!attribute [rw] validation_data
@@ -2073,7 +2074,9 @@ module Aws::CognitoIdentityProvider
2073
2074
  # @!attribute [rw] software_token_mfa_settings
2074
2075
  # User preferences for time-based one-time password (TOTP) MFA.
2075
2076
  # Activates or deactivates TOTP MFA and sets it as the preferred MFA
2076
- # method when multiple methods are available.
2077
+ # method when multiple methods are available. This operation can set
2078
+ # TOTP as a user's preferred MFA method before they register a TOTP
2079
+ # authenticator.
2077
2080
  # @return [Types::SoftwareTokenMfaSettingsType]
2078
2081
  #
2079
2082
  # @!attribute [rw] email_mfa_settings
@@ -4322,9 +4325,7 @@ module Aws::CognitoIdentityProvider
4322
4325
  #
4323
4326
  # Provide this parameter only if you want to use a [custom domain][1]
4324
4327
  # for your user pool. Otherwise, you can omit this parameter and use a
4325
- # [prefix
4326
- # domain](cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html)
4327
- # instead.
4328
+ # [prefix domain][2] instead.
4328
4329
  #
4329
4330
  # When you create a custom domain, the passkey RP ID defaults to the
4330
4331
  # custom domain. If you had a prefix domain active, this will cause
@@ -4335,6 +4336,7 @@ module Aws::CognitoIdentityProvider
4335
4336
  #
4336
4337
  #
4337
4338
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
4339
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html
4338
4340
  # @return [Types::CustomDomainConfigType]
4339
4341
  #
4340
4342
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomainRequest AWS API Documentation
@@ -4507,7 +4509,7 @@ module Aws::CognitoIdentityProvider
4507
4509
  #
4508
4510
  # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
4509
4511
  # activate the Amazon Cognito device-remembering feature. For more
4510
- # infor
4512
+ # information, see [Working with devices][1].
4511
4513
  #
4512
4514
  # </note>
4513
4515
  #
@@ -9754,7 +9756,9 @@ module Aws::CognitoIdentityProvider
9754
9756
  # @!attribute [rw] software_token_mfa_settings
9755
9757
  # User preferences for time-based one-time password (TOTP) MFA.
9756
9758
  # Activates or deactivates TOTP MFA and sets it as the preferred MFA
9757
- # method when multiple methods are available.
9759
+ # method when multiple methods are available. Users must register a
9760
+ # TOTP authenticator before they set this as their preferred MFA
9761
+ # method.
9758
9762
  # @return [Types::SoftwareTokenMfaSettingsType]
9759
9763
  #
9760
9764
  # @!attribute [rw] email_mfa_settings
@@ -11805,7 +11809,7 @@ module Aws::CognitoIdentityProvider
11805
11809
  #
11806
11810
  # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
11807
11811
  # activate the Amazon Cognito device-remembering feature. For more
11808
- # infor
11812
+ # information, see [Working with devices][1].
11809
11813
  #
11810
11814
  # </note>
11811
11815
  #
@@ -13078,21 +13082,22 @@ module Aws::CognitoIdentityProvider
13078
13082
  # @!attribute [rw] user_status
13079
13083
  # The user status. This can be one of the following:
13080
13084
  #
13081
- # * UNCONFIRMED - User has been created but not confirmed.
13085
+ # * `UNCONFIRMED`: User has been created but not confirmed.
13082
13086
  #
13083
- # * CONFIRMED - User has been confirmed.
13087
+ # * `CONFIRMED`: User has been confirmed.
13084
13088
  #
13085
- # * EXTERNAL\_PROVIDER - User signed in with a third-party IdP.
13089
+ # * `EXTERNAL_PROVIDER`: User signed in with a third-party IdP.
13086
13090
  #
13087
- # * UNKNOWN - User status isn't known.
13088
- #
13089
- # * RESET\_REQUIRED - User is confirmed, but the user must request a
13091
+ # * `RESET_REQUIRED`: User is confirmed, but the user must request a
13090
13092
  # code and reset their password before they can sign in.
13091
13093
  #
13092
- # * FORCE\_CHANGE\_PASSWORD - The user is confirmed and the user can
13094
+ # * `FORCE_CHANGE_PASSWORD`: The user is confirmed and the user can
13093
13095
  # sign in using a temporary password, but on first sign-in, the user
13094
13096
  # must change their password to a new value before doing anything
13095
13097
  # else.
13098
+ #
13099
+ # The statuses `ARCHIVED`, `UNKNOWN`, and `COMPROMISED` are no longer
13100
+ # used.
13096
13101
  # @return [String]
13097
13102
  #
13098
13103
  # @!attribute [rw] mfa_options
@@ -54,7 +54,7 @@ module Aws::CognitoIdentityProvider
54
54
  autoload :EndpointProvider, 'aws-sdk-cognitoidentityprovider/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-cognitoidentityprovider/endpoints'
56
56
 
57
- GEM_VERSION = '1.117.0'
57
+ GEM_VERSION = '1.118.0'
58
58
 
59
59
  end
60
60
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cognitoidentityprovider
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.117.0
4
+ version: 1.118.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-03-03 00:00:00.000000000 Z
11
+ date: 2025-03-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core