aws-sdk-cognitoidentityprovider 1.153.0 → 1.154.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: f2d8e69826a921806c9f32d3f91cf185d90bf22fa6b2dd477232f8b9f1ce5226
4
- data.tar.gz: 939e7fdec1b0bd1276a771ab50b027c804491e939d4ecf352fd3ae8bddf6f84e
3
+ metadata.gz: 75ec8bb92f4a2ffff1685d217e134ae73308e425c561818e16924960d5051576
4
+ data.tar.gz: cc897105ab9bb7882111702a4cdfcff5283e35f0f395e894540a6bb0b5389ae4
5
5
  SHA512:
6
- metadata.gz: 4ac162517b646d5f5c75c8c28b888f548e656ea2bf6750b6db17631451f0fd3325d1f2bfa78ff1054193206b4f1202d85cb165bcd158cc511cf5db669f920906
7
- data.tar.gz: aaaf50b049e9793cc75565ce4f9a7666d2d389d99ec81137393b4b9eed45cbdb31604e088df17a2fb0984e4739cbdbed546463d64ab0ac5af0577c6e197ad1f4
6
+ metadata.gz: de79ab7bfa7c36bfbf6ad3b2c37e6b19be415dbbc17abdf44e0d469c8ef0bd09281c55ff1057503f952895062f0da0a84843dcbab2758a81177e6d11b2313548
7
+ data.tar.gz: 9cde89501e44fd57473488fe29dc2302a62543c0eda55b2702218eb99e5f988af8ea6a836f99f0c13e856c8d229a1621559b6330270b07f69e5bbf919262e713
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.154.0 (2026-10-02)
5
+ ------------------
6
+
7
+ * Feature - Amazon Cognito User Pools now supports the OIDC-standard authentication context class reference (ACR) and authentication methods reference (AMR) claims on issued access and Id tokens. Amazon Cognito User Pools also now supports step-up authentication via our existing authentication APIs.
8
+
4
9
  1.153.0 (2026-09-11)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.153.0
1
+ 1.154.0
@@ -1841,6 +1841,37 @@ module Aws::CognitoIdentityProvider
1841
1841
  # `AvailableChallenges` parameter that specifies the available
1842
1842
  # sign-in methods.
1843
1843
  #
1844
+ # * `TARGET_ACR_VALUES`. An optional, space-separated list of the
1845
+ # authentication context class reference (ACR) level URIs that you
1846
+ # want the user to reach. List the levels in priority order, from
1847
+ # highest to lowest. Amazon Cognito attempts the highest-priority
1848
+ # level that the user can satisfy, and falls back through the list.
1849
+ # Amazon Cognito ignores any value that it doesn't recognize. If
1850
+ # none of the requested values are valid, Amazon Cognito returns an
1851
+ # error.
1852
+ #
1853
+ # Requesting step-up authentication with this parameter requires the
1854
+ # Essentials or Plus feature plan. On a lower feature plan,
1855
+ # AdminInitiateAuth returns a FeatureUnavailableInTierException.
1856
+ # `USERNAME` is required. When you provide an `ACCESS_TOKEN`, you
1857
+ # must also provide `TARGET_ACR_VALUES`. Amazon Cognito returns an
1858
+ # error if you provide an `ACCESS_TOKEN` without
1859
+ # `TARGET_ACR_VALUES`. The `USERNAME` that you provide must match
1860
+ # the user that the `ACCESS_TOKEN` was issued for.
1861
+ #
1862
+ # For more information about step-up authentication and how Amazon
1863
+ # Cognito handles multi-factor authentication requirements, see
1864
+ # [Step-up authentication with ACR and AMR][1] in the *Amazon
1865
+ # Cognito Developer Guide*.
1866
+ #
1867
+ # * `MAX_AGE`. An optional integer that sets the maximum number of
1868
+ # seconds allowed since the user last authenticated. If the user's
1869
+ # most recent authentication is older than this value, Amazon
1870
+ # Cognito discards the authentication-methods credit from any access
1871
+ # token that you provide and processes the request as a fresh
1872
+ # authentication toward the target level. The access token itself
1873
+ # remains valid.
1874
+ #
1844
1875
  # USER\_SRP\_AUTH
1845
1876
  # : * `USERNAME` (required)
1846
1877
  #
@@ -1866,13 +1897,14 @@ module Aws::CognitoIdentityProvider
1866
1897
  # with SRP authentication)
1867
1898
  #
1868
1899
  # For more information about `SECRET_HASH`, see [Computing secret hash
1869
- # values][1]. For information about `DEVICE_KEY`, see [Working with user
1870
- # devices in your user pool][2].
1900
+ # values][2]. For information about `DEVICE_KEY`, see [Working with user
1901
+ # devices in your user pool][3].
1871
1902
  #
1872
1903
  #
1873
1904
  #
1874
- # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
1875
- # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
1905
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-step-up-authentication.html
1906
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
1907
+ # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
1876
1908
  #
1877
1909
  # @option params [Hash<String,String>] :client_metadata
1878
1910
  # A map of custom key-value pairs that you can provide as input for any
@@ -2957,6 +2989,7 @@ module Aws::CognitoIdentityProvider
2957
2989
  # * {Types::AdminRespondToAuthChallengeResponse#session #session} => String
2958
2990
  # * {Types::AdminRespondToAuthChallengeResponse#challenge_parameters #challenge_parameters} => Hash&lt;String,String&gt;
2959
2991
  # * {Types::AdminRespondToAuthChallengeResponse#authentication_result #authentication_result} => Types::AuthenticationResultType
2992
+ # * {Types::AdminRespondToAuthChallengeResponse#available_challenges #available_challenges} => Array&lt;String&gt;
2960
2993
  #
2961
2994
  # @example Request syntax with placeholder values
2962
2995
  #
@@ -3001,6 +3034,8 @@ module Aws::CognitoIdentityProvider
3001
3034
  # resp.authentication_result.id_token #=> String
3002
3035
  # resp.authentication_result.new_device_metadata.device_key #=> String
3003
3036
  # resp.authentication_result.new_device_metadata.device_group_key #=> String
3037
+ # resp.available_challenges #=> Array
3038
+ # resp.available_challenges[0] #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"
3004
3039
  #
3005
3040
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallenge AWS API Documentation
3006
3041
  #
@@ -4432,6 +4467,21 @@ module Aws::CognitoIdentityProvider
4432
4467
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html
4433
4468
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html
4434
4469
  #
4470
+ # @option params [Hash<String,String>] :acr_mapping
4471
+ # A mapping between the authentication context class reference (ACR)
4472
+ # levels of your user pool and the ACR values of the external OpenID
4473
+ # Connect (OIDC) identity provider (IdP). The map is keyed by level,
4474
+ # from `Level1` through `Level4`, and each value is the ACR value that
4475
+ # the IdP uses for the corresponding level. Amazon Cognito uses this
4476
+ # mapping to translate a requested user pool ACR level to the value that
4477
+ # the IdP expects, and to map an ACR value that the IdP returns back to
4478
+ # a user pool level. When the IdP returns an ACR value that isn't
4479
+ # mapped, Amazon Cognito resolves it to the lowest level. Only OIDC IdPs
4480
+ # support ACR mapping.
4481
+ #
4482
+ # Setting `AcrMapping` is available in all feature plans. It isn't
4483
+ # restricted to the Essentials or Plus feature plan.
4484
+ #
4435
4485
  # @return [Types::CreateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4436
4486
  #
4437
4487
  # * {Types::CreateIdentityProviderResponse#identity_provider #identity_provider} => Types::IdentityProviderType
@@ -4449,6 +4499,9 @@ module Aws::CognitoIdentityProvider
4449
4499
  # "AttributeMappingKeyType" => "StringType",
4450
4500
  # },
4451
4501
  # idp_identifiers: ["IdpIdentifierType"],
4502
+ # acr_mapping: {
4503
+ # "AcrMappingKeyType" => "AcrValueType",
4504
+ # },
4452
4505
  # })
4453
4506
  #
4454
4507
  # @example Response structure
@@ -4462,6 +4515,8 @@ module Aws::CognitoIdentityProvider
4462
4515
  # resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
4463
4516
  # resp.identity_provider.idp_identifiers #=> Array
4464
4517
  # resp.identity_provider.idp_identifiers[0] #=> String
4518
+ # resp.identity_provider.acr_mapping #=> Hash
4519
+ # resp.identity_provider.acr_mapping["AcrMappingKeyType"] #=> String
4465
4520
  # resp.identity_provider.last_modified_date #=> Time
4466
4521
  # resp.identity_provider.creation_date #=> Time
4467
4522
  #
@@ -5158,6 +5213,30 @@ module Aws::CognitoIdentityProvider
5158
5213
  # The issuer configuration for the user pool. Specifies the issuer type
5159
5214
  # for token generation.
5160
5215
  #
5216
+ # @option params [Hash<String,Types::AcrLevelConfigType>] :acr_configuration
5217
+ # The custom names for the authentication context class reference (ACR)
5218
+ # levels in your user pool. Amazon Cognito defines four fixed ACR levels
5219
+ # that represent increasing authentication assurance. The combination of
5220
+ # authentication factors that satisfies each level is fixed and you
5221
+ # can't change it. With this configuration, you customize only the URI
5222
+ # name that Amazon Cognito reports for each level in the `acr` token
5223
+ # claim.
5224
+ #
5225
+ # You can override a subset of the levels. By default, the levels are
5226
+ # named `urn:cognito:loa:1` through `urn:cognito:loa:4`, and Amazon
5227
+ # Cognito applies the default name to any level that you don't specify.
5228
+ # Each name must be unique across all four levels, including any default
5229
+ # names that apply to levels you don't override. A name can contain any
5230
+ # character that is valid in a URL or a URN.
5231
+ #
5232
+ # Configuring custom ACR level names requires the Essentials or Plus
5233
+ # feature plan. To activate this setting, your user pool must be in the
5234
+ # [ Essentials tier][1] or higher.
5235
+ #
5236
+ #
5237
+ #
5238
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
5239
+ #
5161
5240
  # @return [Types::CreateUserPoolResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5162
5241
  #
5163
5242
  # * {Types::CreateUserPoolResponse#user_pool #user_pool} => Types::UserPoolType
@@ -5772,6 +5851,11 @@ module Aws::CognitoIdentityProvider
5772
5851
  # issuer_configuration: {
5773
5852
  # type: "ORIGINAL", # accepts ORIGINAL, UPDATED
5774
5853
  # },
5854
+ # acr_configuration: {
5855
+ # "AcrLevelKeyType" => {
5856
+ # acr_value: "AcrValueType", # required
5857
+ # },
5858
+ # },
5775
5859
  # })
5776
5860
  #
5777
5861
  # @example Response structure
@@ -5879,6 +5963,8 @@ module Aws::CognitoIdentityProvider
5879
5963
  # resp.user_pool.key_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
5880
5964
  # resp.user_pool.key_configuration.kms_key_arn #=> String
5881
5965
  # resp.user_pool.issuer_configuration.type #=> String, one of "ORIGINAL", "UPDATED"
5966
+ # resp.user_pool.acr_configuration #=> Hash
5967
+ # resp.user_pool.acr_configuration["AcrLevelKeyType"].acr_value #=> String
5882
5968
  #
5883
5969
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPool AWS API Documentation
5884
5970
  #
@@ -7332,6 +7418,8 @@ module Aws::CognitoIdentityProvider
7332
7418
  # resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
7333
7419
  # resp.identity_provider.idp_identifiers #=> Array
7334
7420
  # resp.identity_provider.idp_identifiers[0] #=> String
7421
+ # resp.identity_provider.acr_mapping #=> Hash
7422
+ # resp.identity_provider.acr_mapping["AcrMappingKeyType"] #=> String
7335
7423
  # resp.identity_provider.last_modified_date #=> Time
7336
7424
  # resp.identity_provider.creation_date #=> Time
7337
7425
  #
@@ -7640,10 +7728,9 @@ module Aws::CognitoIdentityProvider
7640
7728
  #
7641
7729
  # To call `DescribeTermsByClient`, you must have the
7642
7730
  # `cognito-idp:DescribeTermsByClient` Identity and Access Management
7643
- # (IAM) permission. This operation additionally validates your
7644
- # permission for `cognito-idp:DescribeTerms`, the action for . As a
7645
- # result, an IAM policy that denies `cognito-idp:DescribeTerms` also
7646
- # denies requests to `DescribeTermsByClient`.
7731
+ # (IAM) permission. An IAM policy that denies
7732
+ # `cognito-idp:DescribeTerms` also denies requests to
7733
+ # `DescribeTermsByClient`.
7647
7734
  #
7648
7735
  # <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
7649
7736
  # in requests for this API operation. For this operation, you must use
@@ -7898,6 +7985,8 @@ module Aws::CognitoIdentityProvider
7898
7985
  # resp.user_pool.key_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
7899
7986
  # resp.user_pool.key_configuration.kms_key_arn #=> String
7900
7987
  # resp.user_pool.issuer_configuration.type #=> String, one of "ORIGINAL", "UPDATED"
7988
+ # resp.user_pool.acr_configuration #=> Hash
7989
+ # resp.user_pool.acr_configuration["AcrLevelKeyType"].acr_value #=> String
7901
7990
  #
7902
7991
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPool AWS API Documentation
7903
7992
  #
@@ -8339,9 +8428,6 @@ module Aws::CognitoIdentityProvider
8339
8428
  # Issues an access token for machine-to-machine (M2M) authorization.
8340
8429
  # Your app client provides its client ID and secret, and receives an
8341
8430
  # access token that authorizes requests to your resource servers.
8342
- # `GetClientToken` provides the same functionality as the OAuth2
8343
- # client-credentials grant; both authorize an application rather than a
8344
- # user.
8345
8431
  #
8346
8432
  # To use this operation, you must configure the app client with a client
8347
8433
  # secret and enable the `ALLOW_CLIENT_TOKEN_AUTH` authentication flow.
@@ -8629,6 +8715,8 @@ module Aws::CognitoIdentityProvider
8629
8715
  # resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
8630
8716
  # resp.identity_provider.idp_identifiers #=> Array
8631
8717
  # resp.identity_provider.idp_identifiers[0] #=> String
8718
+ # resp.identity_provider.acr_mapping #=> Hash
8719
+ # resp.identity_provider.acr_mapping["AcrMappingKeyType"] #=> String
8632
8720
  # resp.identity_provider.last_modified_date #=> Time
8633
8721
  # resp.identity_provider.creation_date #=> Time
8634
8722
  #
@@ -9491,6 +9579,37 @@ module Aws::CognitoIdentityProvider
9491
9579
  # `AvailableChallenges` parameter that specifies the available
9492
9580
  # sign-in methods.
9493
9581
  #
9582
+ # * `TARGET_ACR_VALUES`. An optional, space-separated list of the
9583
+ # authentication context class reference (ACR) level URIs that you
9584
+ # want the user to reach. List the levels in priority order, from
9585
+ # highest to lowest. Amazon Cognito attempts the highest-priority
9586
+ # level that the user can satisfy, and falls back through the list.
9587
+ # Amazon Cognito ignores any value that it doesn't recognize. If
9588
+ # none of the requested values are valid, Amazon Cognito returns an
9589
+ # error.
9590
+ #
9591
+ # Requesting step-up authentication with this parameter requires the
9592
+ # Essentials or Plus feature plan. On a lower feature plan,
9593
+ # InitiateAuth returns a FeatureUnavailableInTierException.
9594
+ # `USERNAME` is required. When you provide an `ACCESS_TOKEN`, you
9595
+ # must also provide `TARGET_ACR_VALUES`. Amazon Cognito returns an
9596
+ # error if you provide an `ACCESS_TOKEN` without
9597
+ # `TARGET_ACR_VALUES`. The `USERNAME` that you provide must match
9598
+ # the user that the `ACCESS_TOKEN` was issued for.
9599
+ #
9600
+ # For more information about step-up authentication and how Amazon
9601
+ # Cognito handles multi-factor authentication requirements, see
9602
+ # [Step-up authentication with ACR and AMR][1] in the *Amazon
9603
+ # Cognito Developer Guide*.
9604
+ #
9605
+ # * `MAX_AGE`. An optional integer that sets the maximum number of
9606
+ # seconds allowed since the user last authenticated. If the user's
9607
+ # most recent authentication is older than this value, Amazon
9608
+ # Cognito discards the authentication-methods credit from any access
9609
+ # token that you provide and processes the request as a fresh
9610
+ # authentication toward the target level. The access token itself
9611
+ # remains valid.
9612
+ #
9494
9613
  # USER\_SRP\_AUTH
9495
9614
  # : * `USERNAME` (required)
9496
9615
  #
@@ -9516,13 +9635,14 @@ module Aws::CognitoIdentityProvider
9516
9635
  # custom challenges)
9517
9636
  #
9518
9637
  # For more information about `SECRET_HASH`, see [Computing secret hash
9519
- # values][1]. For information about `DEVICE_KEY`, see [Working with user
9520
- # devices in your user pool][2].
9638
+ # values][2]. For information about `DEVICE_KEY`, see [Working with user
9639
+ # devices in your user pool][3].
9521
9640
  #
9522
9641
  #
9523
9642
  #
9524
- # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
9525
- # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
9643
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-step-up-authentication.html
9644
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
9645
+ # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
9526
9646
  #
9527
9647
  # @option params [Hash<String,String>] :client_metadata
9528
9648
  # A map of custom key-value pairs that you can provide as input for any
@@ -11398,6 +11518,7 @@ module Aws::CognitoIdentityProvider
11398
11518
  # * {Types::RespondToAuthChallengeResponse#session #session} => String
11399
11519
  # * {Types::RespondToAuthChallengeResponse#challenge_parameters #challenge_parameters} => Hash&lt;String,String&gt;
11400
11520
  # * {Types::RespondToAuthChallengeResponse#authentication_result #authentication_result} => Types::AuthenticationResultType
11521
+ # * {Types::RespondToAuthChallengeResponse#available_challenges #available_challenges} => Array&lt;String&gt;
11401
11522
  #
11402
11523
  # @example Request syntax with placeholder values
11403
11524
  #
@@ -11433,6 +11554,8 @@ module Aws::CognitoIdentityProvider
11433
11554
  # resp.authentication_result.id_token #=> String
11434
11555
  # resp.authentication_result.new_device_metadata.device_key #=> String
11435
11556
  # resp.authentication_result.new_device_metadata.device_group_key #=> String
11557
+ # resp.available_challenges #=> Array
11558
+ # resp.available_challenges[0] #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"
11436
11559
  #
11437
11560
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallenge AWS API Documentation
11438
11561
  #
@@ -12914,6 +13037,16 @@ module Aws::CognitoIdentityProvider
12914
13037
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html
12915
13038
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html
12916
13039
  #
13040
+ # @option params [Hash<String,String>] :acr_mapping
13041
+ # A mapping between the authentication context class reference (ACR)
13042
+ # levels of your user pool and the ACR values of the external OpenID
13043
+ # Connect (OIDC) identity provider (IdP). This mapping has the same
13044
+ # behavior as it does when you create an identity provider. Only OIDC
13045
+ # IdPs support ACR mapping.
13046
+ #
13047
+ # Setting `AcrMapping` is available in all feature plans. It isn't
13048
+ # restricted to the Essentials or Plus feature plan.
13049
+ #
12917
13050
  # @return [Types::UpdateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
12918
13051
  #
12919
13052
  # * {Types::UpdateIdentityProviderResponse#identity_provider #identity_provider} => Types::IdentityProviderType
@@ -12930,6 +13063,9 @@ module Aws::CognitoIdentityProvider
12930
13063
  # "AttributeMappingKeyType" => "StringType",
12931
13064
  # },
12932
13065
  # idp_identifiers: ["IdpIdentifierType"],
13066
+ # acr_mapping: {
13067
+ # "AcrMappingKeyType" => "AcrValueType",
13068
+ # },
12933
13069
  # })
12934
13070
  #
12935
13071
  # @example Response structure
@@ -12943,6 +13079,8 @@ module Aws::CognitoIdentityProvider
12943
13079
  # resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
12944
13080
  # resp.identity_provider.idp_identifiers #=> Array
12945
13081
  # resp.identity_provider.idp_identifiers[0] #=> String
13082
+ # resp.identity_provider.acr_mapping #=> Hash
13083
+ # resp.identity_provider.acr_mapping["AcrMappingKeyType"] #=> String
12946
13084
  # resp.identity_provider.last_modified_date #=> Time
12947
13085
  # resp.identity_provider.creation_date #=> Time
12948
13086
  #
@@ -13731,6 +13869,22 @@ module Aws::CognitoIdentityProvider
13731
13869
  # parameter must match the existing configuration and cannot be
13732
13870
  # modified.
13733
13871
  #
13872
+ # @option params [Hash<String,Types::AcrLevelConfigType>] :acr_configuration
13873
+ # The custom names for the authentication context class reference (ACR)
13874
+ # levels in your user pool. This configuration has the same behavior as
13875
+ # it does when you create a user pool: you customize only the URI name
13876
+ # that Amazon Cognito reports for each of the four fixed ACR levels, and
13877
+ # any level that you don't specify keeps its default name. Each name
13878
+ # must be unique across all four levels, including default names.
13879
+ #
13880
+ # Configuring custom ACR level names requires the Essentials or Plus
13881
+ # feature plan. To activate this setting, your user pool must be in the
13882
+ # [ Essentials tier][1] or higher.
13883
+ #
13884
+ #
13885
+ #
13886
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
13887
+ #
13734
13888
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
13735
13889
  #
13736
13890
  # @example Request syntax with placeholder values
@@ -13858,6 +14012,11 @@ module Aws::CognitoIdentityProvider
13858
14012
  # issuer_configuration: {
13859
14013
  # type: "ORIGINAL", # accepts ORIGINAL, UPDATED
13860
14014
  # },
14015
+ # acr_configuration: {
14016
+ # "AcrLevelKeyType" => {
14017
+ # acr_value: "AcrValueType", # required
14018
+ # },
14019
+ # },
13861
14020
  # })
13862
14021
  #
13863
14022
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPool AWS API Documentation
@@ -14682,7 +14841,7 @@ module Aws::CognitoIdentityProvider
14682
14841
  tracer: tracer
14683
14842
  )
14684
14843
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
14685
- context[:gem_version] = '1.153.0'
14844
+ context[:gem_version] = '1.154.0'
14686
14845
  Seahorse::Client::Request.new(handlers, context)
14687
14846
  end
14688
14847
 
@@ -23,6 +23,12 @@ module Aws::CognitoIdentityProvider
23
23
  AccountTakeoverActionsType = Shapes::StructureShape.new(name: 'AccountTakeoverActionsType')
24
24
  AccountTakeoverEventActionType = Shapes::StringShape.new(name: 'AccountTakeoverEventActionType')
25
25
  AccountTakeoverRiskConfigurationType = Shapes::StructureShape.new(name: 'AccountTakeoverRiskConfigurationType')
26
+ AcrConfigurationType = Shapes::MapShape.new(name: 'AcrConfigurationType')
27
+ AcrLevelConfigType = Shapes::StructureShape.new(name: 'AcrLevelConfigType')
28
+ AcrLevelKeyType = Shapes::StringShape.new(name: 'AcrLevelKeyType')
29
+ AcrMappingKeyType = Shapes::StringShape.new(name: 'AcrMappingKeyType')
30
+ AcrMappingType = Shapes::MapShape.new(name: 'AcrMappingType')
31
+ AcrValueType = Shapes::StringShape.new(name: 'AcrValueType')
26
32
  AddCustomAttributesRequest = Shapes::StructureShape.new(name: 'AddCustomAttributesRequest')
27
33
  AddCustomAttributesResponse = Shapes::StructureShape.new(name: 'AddCustomAttributesResponse')
28
34
  AddUserPoolClientSecretRequest = Shapes::StructureShape.new(name: 'AddUserPoolClientSecretRequest')
@@ -670,6 +676,15 @@ module Aws::CognitoIdentityProvider
670
676
  AccountTakeoverRiskConfigurationType.add_member(:actions, Shapes::ShapeRef.new(shape: AccountTakeoverActionsType, required: true, location_name: "Actions"))
671
677
  AccountTakeoverRiskConfigurationType.struct_class = Types::AccountTakeoverRiskConfigurationType
672
678
 
679
+ AcrConfigurationType.key = Shapes::ShapeRef.new(shape: AcrLevelKeyType)
680
+ AcrConfigurationType.value = Shapes::ShapeRef.new(shape: AcrLevelConfigType)
681
+
682
+ AcrLevelConfigType.add_member(:acr_value, Shapes::ShapeRef.new(shape: AcrValueType, required: true, location_name: "AcrValue"))
683
+ AcrLevelConfigType.struct_class = Types::AcrLevelConfigType
684
+
685
+ AcrMappingType.key = Shapes::ShapeRef.new(shape: AcrMappingKeyType)
686
+ AcrMappingType.value = Shapes::ShapeRef.new(shape: AcrValueType)
687
+
673
688
  AddCustomAttributesRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
674
689
  AddCustomAttributesRequest.add_member(:custom_attributes, Shapes::ShapeRef.new(shape: CustomAttributesListType, required: true, location_name: "CustomAttributes"))
675
690
  AddCustomAttributesRequest.struct_class = Types::AddCustomAttributesRequest
@@ -868,6 +883,7 @@ module Aws::CognitoIdentityProvider
868
883
  AdminRespondToAuthChallengeResponse.add_member(:session, Shapes::ShapeRef.new(shape: SessionType, location_name: "Session"))
869
884
  AdminRespondToAuthChallengeResponse.add_member(:challenge_parameters, Shapes::ShapeRef.new(shape: ChallengeParametersType, location_name: "ChallengeParameters"))
870
885
  AdminRespondToAuthChallengeResponse.add_member(:authentication_result, Shapes::ShapeRef.new(shape: AuthenticationResultType, location_name: "AuthenticationResult"))
886
+ AdminRespondToAuthChallengeResponse.add_member(:available_challenges, Shapes::ShapeRef.new(shape: AvailableChallengeListType, location_name: "AvailableChallenges"))
871
887
  AdminRespondToAuthChallengeResponse.struct_class = Types::AdminRespondToAuthChallengeResponse
872
888
 
873
889
  AdminSetUserMFAPreferenceRequest.add_member(:sms_mfa_settings, Shapes::ShapeRef.new(shape: SMSMfaSettingsType, location_name: "SMSMfaSettings"))
@@ -1132,6 +1148,7 @@ module Aws::CognitoIdentityProvider
1132
1148
  CreateIdentityProviderRequest.add_member(:provider_details, Shapes::ShapeRef.new(shape: ProviderDetailsType, required: true, location_name: "ProviderDetails"))
1133
1149
  CreateIdentityProviderRequest.add_member(:attribute_mapping, Shapes::ShapeRef.new(shape: AttributeMappingType, location_name: "AttributeMapping"))
1134
1150
  CreateIdentityProviderRequest.add_member(:idp_identifiers, Shapes::ShapeRef.new(shape: IdpIdentifiersListType, location_name: "IdpIdentifiers"))
1151
+ CreateIdentityProviderRequest.add_member(:acr_mapping, Shapes::ShapeRef.new(shape: AcrMappingType, location_name: "AcrMapping"))
1135
1152
  CreateIdentityProviderRequest.struct_class = Types::CreateIdentityProviderRequest
1136
1153
 
1137
1154
  CreateIdentityProviderResponse.add_member(:identity_provider, Shapes::ShapeRef.new(shape: IdentityProviderType, required: true, location_name: "IdentityProvider"))
@@ -1251,6 +1268,7 @@ module Aws::CognitoIdentityProvider
1251
1268
  CreateUserPoolRequest.add_member(:user_pool_tier, Shapes::ShapeRef.new(shape: UserPoolTierType, location_name: "UserPoolTier"))
1252
1269
  CreateUserPoolRequest.add_member(:key_configuration, Shapes::ShapeRef.new(shape: KeyConfigurationType, location_name: "KeyConfiguration"))
1253
1270
  CreateUserPoolRequest.add_member(:issuer_configuration, Shapes::ShapeRef.new(shape: IssuerConfigurationType, location_name: "IssuerConfiguration"))
1271
+ CreateUserPoolRequest.add_member(:acr_configuration, Shapes::ShapeRef.new(shape: AcrConfigurationType, location_name: "AcrConfiguration"))
1254
1272
  CreateUserPoolRequest.struct_class = Types::CreateUserPoolRequest
1255
1273
 
1256
1274
  CreateUserPoolResponse.add_member(:user_pool, Shapes::ShapeRef.new(shape: UserPoolType, location_name: "UserPool"))
@@ -1666,6 +1684,7 @@ module Aws::CognitoIdentityProvider
1666
1684
  IdentityProviderType.add_member(:provider_details, Shapes::ShapeRef.new(shape: ProviderDetailsType, location_name: "ProviderDetails"))
1667
1685
  IdentityProviderType.add_member(:attribute_mapping, Shapes::ShapeRef.new(shape: AttributeMappingType, location_name: "AttributeMapping"))
1668
1686
  IdentityProviderType.add_member(:idp_identifiers, Shapes::ShapeRef.new(shape: IdpIdentifiersListType, location_name: "IdpIdentifiers"))
1687
+ IdentityProviderType.add_member(:acr_mapping, Shapes::ShapeRef.new(shape: AcrMappingType, location_name: "AcrMapping"))
1669
1688
  IdentityProviderType.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: DateType, location_name: "LastModifiedDate"))
1670
1689
  IdentityProviderType.add_member(:creation_date, Shapes::ShapeRef.new(shape: DateType, location_name: "CreationDate"))
1671
1690
  IdentityProviderType.struct_class = Types::IdentityProviderType
@@ -2052,6 +2071,7 @@ module Aws::CognitoIdentityProvider
2052
2071
  RespondToAuthChallengeResponse.add_member(:session, Shapes::ShapeRef.new(shape: SessionType, location_name: "Session"))
2053
2072
  RespondToAuthChallengeResponse.add_member(:challenge_parameters, Shapes::ShapeRef.new(shape: ChallengeParametersType, location_name: "ChallengeParameters"))
2054
2073
  RespondToAuthChallengeResponse.add_member(:authentication_result, Shapes::ShapeRef.new(shape: AuthenticationResultType, location_name: "AuthenticationResult"))
2074
+ RespondToAuthChallengeResponse.add_member(:available_challenges, Shapes::ShapeRef.new(shape: AvailableChallengeListType, location_name: "AvailableChallenges"))
2055
2075
  RespondToAuthChallengeResponse.struct_class = Types::RespondToAuthChallengeResponse
2056
2076
 
2057
2077
  RevokeTokenRequest.add_member(:token, Shapes::ShapeRef.new(shape: TokenModelType, required: true, location_name: "Token"))
@@ -2338,6 +2358,7 @@ module Aws::CognitoIdentityProvider
2338
2358
  UpdateIdentityProviderRequest.add_member(:provider_details, Shapes::ShapeRef.new(shape: ProviderDetailsType, location_name: "ProviderDetails"))
2339
2359
  UpdateIdentityProviderRequest.add_member(:attribute_mapping, Shapes::ShapeRef.new(shape: AttributeMappingType, location_name: "AttributeMapping"))
2340
2360
  UpdateIdentityProviderRequest.add_member(:idp_identifiers, Shapes::ShapeRef.new(shape: IdpIdentifiersListType, location_name: "IdpIdentifiers"))
2361
+ UpdateIdentityProviderRequest.add_member(:acr_mapping, Shapes::ShapeRef.new(shape: AcrMappingType, location_name: "AcrMapping"))
2341
2362
  UpdateIdentityProviderRequest.struct_class = Types::UpdateIdentityProviderRequest
2342
2363
 
2343
2364
  UpdateIdentityProviderResponse.add_member(:identity_provider, Shapes::ShapeRef.new(shape: IdentityProviderType, required: true, location_name: "IdentityProvider"))
@@ -2459,6 +2480,7 @@ module Aws::CognitoIdentityProvider
2459
2480
  UpdateUserPoolRequest.add_member(:user_pool_tier, Shapes::ShapeRef.new(shape: UserPoolTierType, location_name: "UserPoolTier"))
2460
2481
  UpdateUserPoolRequest.add_member(:key_configuration, Shapes::ShapeRef.new(shape: KeyConfigurationType, location_name: "KeyConfiguration"))
2461
2482
  UpdateUserPoolRequest.add_member(:issuer_configuration, Shapes::ShapeRef.new(shape: IssuerConfigurationType, location_name: "IssuerConfiguration"))
2483
+ UpdateUserPoolRequest.add_member(:acr_configuration, Shapes::ShapeRef.new(shape: AcrConfigurationType, location_name: "AcrConfiguration"))
2462
2484
  UpdateUserPoolRequest.struct_class = Types::UpdateUserPoolRequest
2463
2485
 
2464
2486
  UpdateUserPoolResponse.struct_class = Types::UpdateUserPoolResponse
@@ -2611,6 +2633,7 @@ module Aws::CognitoIdentityProvider
2611
2633
  UserPoolType.add_member(:user_pool_tier, Shapes::ShapeRef.new(shape: UserPoolTierType, location_name: "UserPoolTier"))
2612
2634
  UserPoolType.add_member(:key_configuration, Shapes::ShapeRef.new(shape: KeyConfigurationType, location_name: "KeyConfiguration"))
2613
2635
  UserPoolType.add_member(:issuer_configuration, Shapes::ShapeRef.new(shape: IssuerConfigurationType, location_name: "IssuerConfiguration"))
2636
+ UserPoolType.add_member(:acr_configuration, Shapes::ShapeRef.new(shape: AcrConfigurationType, location_name: "AcrConfiguration"))
2614
2637
  UserPoolType.struct_class = Types::UserPoolType
2615
2638
 
2616
2639
  UserType.add_member(:username, Shapes::ShapeRef.new(shape: UsernameType, location_name: "Username"))
@@ -2986,6 +3009,7 @@ module Aws::CognitoIdentityProvider
2986
3009
  o.errors << Shapes::ShapeRef.new(shape: UserNotFoundException)
2987
3010
  o.errors << Shapes::ShapeRef.new(shape: UserNotConfirmedException)
2988
3011
  o.errors << Shapes::ShapeRef.new(shape: OperationNotEnabledException)
3012
+ o.errors << Shapes::ShapeRef.new(shape: FeatureUnavailableInTierException)
2989
3013
  end)
2990
3014
 
2991
3015
  api.add_operation(:admin_link_provider_for_user, Seahorse::Model::Operation.new.tap do |o|
@@ -4237,6 +4261,7 @@ module Aws::CognitoIdentityProvider
4237
4261
  o.errors << Shapes::ShapeRef.new(shape: InvalidEmailRoleAccessPolicyException)
4238
4262
  o.errors << Shapes::ShapeRef.new(shape: InvalidSmsRoleTrustRelationshipException)
4239
4263
  o.errors << Shapes::ShapeRef.new(shape: OperationNotEnabledException)
4264
+ o.errors << Shapes::ShapeRef.new(shape: FeatureUnavailableInTierException)
4240
4265
  o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
4241
4266
  end)
4242
4267
 
@@ -136,6 +136,27 @@ module Aws::CognitoIdentityProvider
136
136
  include Aws::Structure
137
137
  end
138
138
 
139
+ # The configuration for a single authentication context class reference
140
+ # (ACR) level in a user pool. Each entry in an `AcrConfiguration` map
141
+ # associates a level (`Level1` through `Level4`) with this
142
+ # configuration, which provides the custom name that Amazon Cognito
143
+ # reports for that level in the `acr` token claim.
144
+ #
145
+ # @!attribute [rw] acr_value
146
+ # The custom name for this authentication context class reference
147
+ # (ACR) level. This value is the URI that Amazon Cognito reports in
148
+ # the `acr` token claim when a user meets this level. The name must be
149
+ # unique across all levels in the user pool, including default names.
150
+ # @return [String]
151
+ #
152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AcrLevelConfigType AWS API Documentation
153
+ #
154
+ class AcrLevelConfigType < Struct.new(
155
+ :acr_value)
156
+ SENSITIVE = []
157
+ include Aws::Structure
158
+ end
159
+
139
160
  # Represents the request to add custom attributes.
140
161
  #
141
162
  # @!attribute [rw] user_pool_id
@@ -1082,6 +1103,37 @@ module Aws::CognitoIdentityProvider
1082
1103
  # `AvailableChallenges` parameter that specifies the available
1083
1104
  # sign-in methods.
1084
1105
  #
1106
+ # * `TARGET_ACR_VALUES`. An optional, space-separated list of the
1107
+ # authentication context class reference (ACR) level URIs that you
1108
+ # want the user to reach. List the levels in priority order, from
1109
+ # highest to lowest. Amazon Cognito attempts the highest-priority
1110
+ # level that the user can satisfy, and falls back through the
1111
+ # list. Amazon Cognito ignores any value that it doesn't
1112
+ # recognize. If none of the requested values are valid, Amazon
1113
+ # Cognito returns an error.
1114
+ #
1115
+ # Requesting step-up authentication with this parameter requires
1116
+ # the Essentials or Plus feature plan. On a lower feature plan,
1117
+ # AdminInitiateAuth returns a FeatureUnavailableInTierException.
1118
+ # `USERNAME` is required. When you provide an `ACCESS_TOKEN`, you
1119
+ # must also provide `TARGET_ACR_VALUES`. Amazon Cognito returns an
1120
+ # error if you provide an `ACCESS_TOKEN` without
1121
+ # `TARGET_ACR_VALUES`. The `USERNAME` that you provide must match
1122
+ # the user that the `ACCESS_TOKEN` was issued for.
1123
+ #
1124
+ # For more information about step-up authentication and how Amazon
1125
+ # Cognito handles multi-factor authentication requirements, see
1126
+ # [Step-up authentication with ACR and AMR][1] in the *Amazon
1127
+ # Cognito Developer Guide*.
1128
+ #
1129
+ # * `MAX_AGE`. An optional integer that sets the maximum number of
1130
+ # seconds allowed since the user last authenticated. If the
1131
+ # user's most recent authentication is older than this value,
1132
+ # Amazon Cognito discards the authentication-methods credit from
1133
+ # any access token that you provide and processes the request as a
1134
+ # fresh authentication toward the target level. The access token
1135
+ # itself remains valid.
1136
+ #
1085
1137
  # USER\_SRP\_AUTH
1086
1138
  # : * `USERNAME` (required)
1087
1139
  #
@@ -1107,13 +1159,14 @@ module Aws::CognitoIdentityProvider
1107
1159
  # with SRP authentication)
1108
1160
  #
1109
1161
  # For more information about `SECRET_HASH`, see [Computing secret hash
1110
- # values][1]. For information about `DEVICE_KEY`, see [Working with
1111
- # user devices in your user pool][2].
1162
+ # values][2]. For information about `DEVICE_KEY`, see [Working with
1163
+ # user devices in your user pool][3].
1112
1164
  #
1113
1165
  #
1114
1166
  #
1115
- # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
1116
- # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
1167
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-step-up-authentication.html
1168
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
1169
+ # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
1117
1170
  # @return [Hash<String,String>]
1118
1171
  #
1119
1172
  # @!attribute [rw] client_metadata
@@ -2202,13 +2255,26 @@ module Aws::CognitoIdentityProvider
2202
2255
  # successful sign-in.
2203
2256
  # @return [Types::AuthenticationResultType]
2204
2257
  #
2258
+ # @!attribute [rw] available_challenges
2259
+ # This response parameter lists the available authentication
2260
+ # challenges that users can select from in [choice-based
2261
+ # authentication][1]. For example, they might be able to choose
2262
+ # between passkey authentication, a one-time password from an SMS
2263
+ # message, and a traditional password.
2264
+ #
2265
+ #
2266
+ #
2267
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice
2268
+ # @return [Array<String>]
2269
+ #
2205
2270
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallengeResponse AWS API Documentation
2206
2271
  #
2207
2272
  class AdminRespondToAuthChallengeResponse < Struct.new(
2208
2273
  :challenge_name,
2209
2274
  :session,
2210
2275
  :challenge_parameters,
2211
- :authentication_result)
2276
+ :authentication_result,
2277
+ :available_challenges)
2212
2278
  SENSITIVE = [:session]
2213
2279
  include Aws::Structure
2214
2280
  end
@@ -3940,6 +4006,22 @@ module Aws::CognitoIdentityProvider
3940
4006
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html
3941
4007
  # @return [Array<String>]
3942
4008
  #
4009
+ # @!attribute [rw] acr_mapping
4010
+ # A mapping between the authentication context class reference (ACR)
4011
+ # levels of your user pool and the ACR values of the external OpenID
4012
+ # Connect (OIDC) identity provider (IdP). The map is keyed by level,
4013
+ # from `Level1` through `Level4`, and each value is the ACR value that
4014
+ # the IdP uses for the corresponding level. Amazon Cognito uses this
4015
+ # mapping to translate a requested user pool ACR level to the value
4016
+ # that the IdP expects, and to map an ACR value that the IdP returns
4017
+ # back to a user pool level. When the IdP returns an ACR value that
4018
+ # isn't mapped, Amazon Cognito resolves it to the lowest level. Only
4019
+ # OIDC IdPs support ACR mapping.
4020
+ #
4021
+ # Setting `AcrMapping` is available in all feature plans. It isn't
4022
+ # restricted to the Essentials or Plus feature plan.
4023
+ # @return [Hash<String,String>]
4024
+ #
3943
4025
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateIdentityProviderRequest AWS API Documentation
3944
4026
  #
3945
4027
  class CreateIdentityProviderRequest < Struct.new(
@@ -3948,7 +4030,8 @@ module Aws::CognitoIdentityProvider
3948
4030
  :provider_type,
3949
4031
  :provider_details,
3950
4032
  :attribute_mapping,
3951
- :idp_identifiers)
4033
+ :idp_identifiers,
4034
+ :acr_mapping)
3952
4035
  SENSITIVE = []
3953
4036
  include Aws::Structure
3954
4037
  end
@@ -5048,6 +5131,31 @@ module Aws::CognitoIdentityProvider
5048
5131
  # type for token generation.
5049
5132
  # @return [Types::IssuerConfigurationType]
5050
5133
  #
5134
+ # @!attribute [rw] acr_configuration
5135
+ # The custom names for the authentication context class reference
5136
+ # (ACR) levels in your user pool. Amazon Cognito defines four fixed
5137
+ # ACR levels that represent increasing authentication assurance. The
5138
+ # combination of authentication factors that satisfies each level is
5139
+ # fixed and you can't change it. With this configuration, you
5140
+ # customize only the URI name that Amazon Cognito reports for each
5141
+ # level in the `acr` token claim.
5142
+ #
5143
+ # You can override a subset of the levels. By default, the levels are
5144
+ # named `urn:cognito:loa:1` through `urn:cognito:loa:4`, and Amazon
5145
+ # Cognito applies the default name to any level that you don't
5146
+ # specify. Each name must be unique across all four levels, including
5147
+ # any default names that apply to levels you don't override. A name
5148
+ # can contain any character that is valid in a URL or a URN.
5149
+ #
5150
+ # Configuring custom ACR level names requires the Essentials or Plus
5151
+ # feature plan. To activate this setting, your user pool must be in
5152
+ # the [ Essentials tier][1] or higher.
5153
+ #
5154
+ #
5155
+ #
5156
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
5157
+ # @return [Hash<String,Types::AcrLevelConfigType>]
5158
+ #
5051
5159
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolRequest AWS API Documentation
5052
5160
  #
5053
5161
  class CreateUserPoolRequest < Struct.new(
@@ -5076,7 +5184,8 @@ module Aws::CognitoIdentityProvider
5076
5184
  :account_recovery_setting,
5077
5185
  :user_pool_tier,
5078
5186
  :key_configuration,
5079
- :issuer_configuration)
5187
+ :issuer_configuration,
5188
+ :acr_configuration)
5080
5189
  SENSITIVE = []
5081
5190
  include Aws::Structure
5082
5191
  end
@@ -5675,7 +5784,7 @@ module Aws::CognitoIdentityProvider
5675
5784
  end
5676
5785
 
5677
5786
  # @!attribute [rw] terms
5678
- # A summary of the requested terms documents. Includes a unique
5787
+ # A summary of the requested terms documents, including a unique
5679
5788
  # identifier for later changes to the terms documents.
5680
5789
  # @return [Types::TermsType]
5681
5790
  #
@@ -6512,8 +6621,17 @@ module Aws::CognitoIdentityProvider
6512
6621
  include Aws::Structure
6513
6622
  end
6514
6623
 
6515
- # This exception is thrown when a feature you attempted to configure
6516
- # isn't available in your current feature plan.
6624
+ # This exception is thrown when a feature that you attempted to use or
6625
+ # configure isn't included in your user pool's current feature plan.
6626
+ # This can occur when:
6627
+ #
6628
+ # * You configure a feature that your feature plan doesn't support.
6629
+ #
6630
+ # * You make a request that uses a feature that requires a higher
6631
+ # feature plan.
6632
+ #
6633
+ # To resolve this issue, upgrade your user pool to a feature plan that
6634
+ # includes the feature.
6517
6635
  #
6518
6636
  # @!attribute [rw] message
6519
6637
  # @return [String]
@@ -7663,6 +7781,15 @@ module Aws::CognitoIdentityProvider
7663
7781
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html#get-authorize-request-parameters
7664
7782
  # @return [Array<String>]
7665
7783
  #
7784
+ # @!attribute [rw] acr_mapping
7785
+ # A mapping between the authentication context class reference (ACR)
7786
+ # levels of your user pool and the ACR values of the external OpenID
7787
+ # Connect (OIDC) identity provider (IdP), so that your application
7788
+ # gets a consistent step-up experience regardless of which IdP
7789
+ # authenticated the user. The map is keyed by level, from `Level1`
7790
+ # through `Level4`.
7791
+ # @return [Hash<String,String>]
7792
+ #
7666
7793
  # @!attribute [rw] last_modified_date
7667
7794
  # The date and time when the item was modified. Amazon Cognito returns
7668
7795
  # this timestamp in UNIX epoch time format. Your SDK might render the
@@ -7686,6 +7813,7 @@ module Aws::CognitoIdentityProvider
7686
7813
  :provider_details,
7687
7814
  :attribute_mapping,
7688
7815
  :idp_identifiers,
7816
+ :acr_mapping,
7689
7817
  :last_modified_date,
7690
7818
  :creation_date)
7691
7819
  SENSITIVE = []
@@ -7791,6 +7919,37 @@ module Aws::CognitoIdentityProvider
7791
7919
  # `AvailableChallenges` parameter that specifies the available
7792
7920
  # sign-in methods.
7793
7921
  #
7922
+ # * `TARGET_ACR_VALUES`. An optional, space-separated list of the
7923
+ # authentication context class reference (ACR) level URIs that you
7924
+ # want the user to reach. List the levels in priority order, from
7925
+ # highest to lowest. Amazon Cognito attempts the highest-priority
7926
+ # level that the user can satisfy, and falls back through the
7927
+ # list. Amazon Cognito ignores any value that it doesn't
7928
+ # recognize. If none of the requested values are valid, Amazon
7929
+ # Cognito returns an error.
7930
+ #
7931
+ # Requesting step-up authentication with this parameter requires
7932
+ # the Essentials or Plus feature plan. On a lower feature plan,
7933
+ # InitiateAuth returns a FeatureUnavailableInTierException.
7934
+ # `USERNAME` is required. When you provide an `ACCESS_TOKEN`, you
7935
+ # must also provide `TARGET_ACR_VALUES`. Amazon Cognito returns an
7936
+ # error if you provide an `ACCESS_TOKEN` without
7937
+ # `TARGET_ACR_VALUES`. The `USERNAME` that you provide must match
7938
+ # the user that the `ACCESS_TOKEN` was issued for.
7939
+ #
7940
+ # For more information about step-up authentication and how Amazon
7941
+ # Cognito handles multi-factor authentication requirements, see
7942
+ # [Step-up authentication with ACR and AMR][1] in the *Amazon
7943
+ # Cognito Developer Guide*.
7944
+ #
7945
+ # * `MAX_AGE`. An optional integer that sets the maximum number of
7946
+ # seconds allowed since the user last authenticated. If the
7947
+ # user's most recent authentication is older than this value,
7948
+ # Amazon Cognito discards the authentication-methods credit from
7949
+ # any access token that you provide and processes the request as a
7950
+ # fresh authentication toward the target level. The access token
7951
+ # itself remains valid.
7952
+ #
7794
7953
  # USER\_SRP\_AUTH
7795
7954
  # : * `USERNAME` (required)
7796
7955
  #
@@ -7816,13 +7975,14 @@ module Aws::CognitoIdentityProvider
7816
7975
  # custom challenges)
7817
7976
  #
7818
7977
  # For more information about `SECRET_HASH`, see [Computing secret hash
7819
- # values][1]. For information about `DEVICE_KEY`, see [Working with
7820
- # user devices in your user pool][2].
7978
+ # values][2]. For information about `DEVICE_KEY`, see [Working with
7979
+ # user devices in your user pool][3].
7821
7980
  #
7822
7981
  #
7823
7982
  #
7824
- # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
7825
- # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
7983
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-step-up-authentication.html
7984
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
7985
+ # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
7826
7986
  # @return [Hash<String,String>]
7827
7987
  #
7828
7988
  # @!attribute [rw] client_metadata
@@ -10694,13 +10854,26 @@ module Aws::CognitoIdentityProvider
10694
10854
  # successful sign-in.
10695
10855
  # @return [Types::AuthenticationResultType]
10696
10856
  #
10857
+ # @!attribute [rw] available_challenges
10858
+ # This response parameter lists the available authentication
10859
+ # challenges that users can select from in [choice-based
10860
+ # authentication][1]. For example, they might be able to choose
10861
+ # between passkey authentication, a one-time password from an SMS
10862
+ # message, and a traditional password.
10863
+ #
10864
+ #
10865
+ #
10866
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice
10867
+ # @return [Array<String>]
10868
+ #
10697
10869
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallengeResponse AWS API Documentation
10698
10870
  #
10699
10871
  class RespondToAuthChallengeResponse < Struct.new(
10700
10872
  :challenge_name,
10701
10873
  :session,
10702
10874
  :challenge_parameters,
10703
- :authentication_result)
10875
+ :authentication_result,
10876
+ :available_challenges)
10704
10877
  SENSITIVE = [:session]
10705
10878
  include Aws::Structure
10706
10879
  end
@@ -12527,6 +12700,17 @@ module Aws::CognitoIdentityProvider
12527
12700
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html
12528
12701
  # @return [Array<String>]
12529
12702
  #
12703
+ # @!attribute [rw] acr_mapping
12704
+ # A mapping between the authentication context class reference (ACR)
12705
+ # levels of your user pool and the ACR values of the external OpenID
12706
+ # Connect (OIDC) identity provider (IdP). This mapping has the same
12707
+ # behavior as it does when you create an identity provider. Only OIDC
12708
+ # IdPs support ACR mapping.
12709
+ #
12710
+ # Setting `AcrMapping` is available in all feature plans. It isn't
12711
+ # restricted to the Essentials or Plus feature plan.
12712
+ # @return [Hash<String,String>]
12713
+ #
12530
12714
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProviderRequest AWS API Documentation
12531
12715
  #
12532
12716
  class UpdateIdentityProviderRequest < Struct.new(
@@ -12534,7 +12718,8 @@ module Aws::CognitoIdentityProvider
12534
12718
  :provider_name,
12535
12719
  :provider_details,
12536
12720
  :attribute_mapping,
12537
- :idp_identifiers)
12721
+ :idp_identifiers,
12722
+ :acr_mapping)
12538
12723
  SENSITIVE = []
12539
12724
  include Aws::Structure
12540
12725
  end
@@ -13606,6 +13791,24 @@ module Aws::CognitoIdentityProvider
13606
13791
  # modified.
13607
13792
  # @return [Types::IssuerConfigurationType]
13608
13793
  #
13794
+ # @!attribute [rw] acr_configuration
13795
+ # The custom names for the authentication context class reference
13796
+ # (ACR) levels in your user pool. This configuration has the same
13797
+ # behavior as it does when you create a user pool: you customize only
13798
+ # the URI name that Amazon Cognito reports for each of the four fixed
13799
+ # ACR levels, and any level that you don't specify keeps its default
13800
+ # name. Each name must be unique across all four levels, including
13801
+ # default names.
13802
+ #
13803
+ # Configuring custom ACR level names requires the Essentials or Plus
13804
+ # feature plan. To activate this setting, your user pool must be in
13805
+ # the [ Essentials tier][1] or higher.
13806
+ #
13807
+ #
13808
+ #
13809
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
13810
+ # @return [Hash<String,Types::AcrLevelConfigType>]
13811
+ #
13609
13812
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolRequest AWS API Documentation
13610
13813
  #
13611
13814
  class UpdateUserPoolRequest < Struct.new(
@@ -13631,7 +13834,8 @@ module Aws::CognitoIdentityProvider
13631
13834
  :pool_name,
13632
13835
  :user_pool_tier,
13633
13836
  :key_configuration,
13634
- :issuer_configuration)
13837
+ :issuer_configuration,
13838
+ :acr_configuration)
13635
13839
  SENSITIVE = []
13636
13840
  include Aws::Structure
13637
13841
  end
@@ -14823,6 +15027,21 @@ module Aws::CognitoIdentityProvider
14823
15027
  # settings.
14824
15028
  # @return [Types::IssuerConfigurationType]
14825
15029
  #
15030
+ # @!attribute [rw] acr_configuration
15031
+ # The names of the authentication context class reference (ACR) levels
15032
+ # for the user pool. Amazon Cognito always returns the effective
15033
+ # configuration, with default names merged in for any level that you
15034
+ # haven't customized.
15035
+ #
15036
+ # Configuring custom ACR level names requires the Essentials or Plus
15037
+ # feature plan. To activate this setting, your user pool must be in
15038
+ # the [ Essentials tier][1] or higher.
15039
+ #
15040
+ #
15041
+ #
15042
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
15043
+ # @return [Hash<String,Types::AcrLevelConfigType>]
15044
+ #
14826
15045
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolType AWS API Documentation
14827
15046
  #
14828
15047
  class UserPoolType < Struct.new(
@@ -14861,7 +15080,8 @@ module Aws::CognitoIdentityProvider
14861
15080
  :account_recovery_setting,
14862
15081
  :user_pool_tier,
14863
15082
  :key_configuration,
14864
- :issuer_configuration)
15083
+ :issuer_configuration,
15084
+ :acr_configuration)
14865
15085
  SENSITIVE = []
14866
15086
  include Aws::Structure
14867
15087
  end
@@ -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.153.0'
57
+ GEM_VERSION = '1.154.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -374,6 +374,7 @@ module Aws
374
374
  def session: () -> ::String
375
375
  def challenge_parameters: () -> ::Hash[::String, ::String]
376
376
  def authentication_result: () -> Types::AuthenticationResultType
377
+ def available_challenges: () -> ::Array[("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")]
377
378
  end
378
379
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_respond_to_auth_challenge-instance_method
379
380
  def admin_respond_to_auth_challenge: (
@@ -613,7 +614,8 @@ module Aws
613
614
  provider_type: ("SAML" | "Facebook" | "Google" | "LoginWithAmazon" | "SignInWithApple" | "OIDC"),
614
615
  provider_details: Hash[::String, ::String],
615
616
  ?attribute_mapping: Hash[::String, ::String],
616
- ?idp_identifiers: Array[::String]
617
+ ?idp_identifiers: Array[::String],
618
+ ?acr_mapping: Hash[::String, ::String]
617
619
  ) -> _CreateIdentityProviderResponseSuccess
618
620
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIdentityProviderResponseSuccess
619
621
 
@@ -749,7 +751,10 @@ module Aws
749
751
  },
750
752
  ?issuer_configuration: {
751
753
  type: ("ORIGINAL" | "UPDATED")?
752
- }
754
+ },
755
+ ?acr_configuration: Hash[::String, {
756
+ acr_value: ::String
757
+ }]
753
758
  ) -> _CreateUserPoolResponseSuccess
754
759
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserPoolResponseSuccess
755
760
 
@@ -1498,6 +1503,7 @@ module Aws
1498
1503
  def session: () -> ::String
1499
1504
  def challenge_parameters: () -> ::Hash[::String, ::String]
1500
1505
  def authentication_result: () -> Types::AuthenticationResultType
1506
+ def available_challenges: () -> ::Array[("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")]
1501
1507
  end
1502
1508
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#respond_to_auth_challenge-instance_method
1503
1509
  def respond_to_auth_challenge: (
@@ -1828,7 +1834,8 @@ module Aws
1828
1834
  provider_name: ::String,
1829
1835
  ?provider_details: Hash[::String, ::String],
1830
1836
  ?attribute_mapping: Hash[::String, ::String],
1831
- ?idp_identifiers: Array[::String]
1837
+ ?idp_identifiers: Array[::String],
1838
+ ?acr_mapping: Hash[::String, ::String]
1832
1839
  ) -> _UpdateIdentityProviderResponseSuccess
1833
1840
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateIdentityProviderResponseSuccess
1834
1841
 
@@ -1974,7 +1981,10 @@ module Aws
1974
1981
  },
1975
1982
  ?issuer_configuration: {
1976
1983
  type: ("ORIGINAL" | "UPDATED")?
1977
- }
1984
+ },
1985
+ ?acr_configuration: Hash[::String, {
1986
+ acr_value: ::String
1987
+ }]
1978
1988
  ) -> _UpdateUserPoolResponseSuccess
1979
1989
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserPoolResponseSuccess
1980
1990
 
data/sig/types.rbs CHANGED
@@ -37,6 +37,11 @@ module Aws::CognitoIdentityProvider
37
37
  SENSITIVE: []
38
38
  end
39
39
 
40
+ class AcrLevelConfigType
41
+ attr_accessor acr_value: ::String
42
+ SENSITIVE: []
43
+ end
44
+
40
45
  class AddCustomAttributesRequest
41
46
  attr_accessor user_pool_id: ::String
42
47
  attr_accessor custom_attributes: ::Array[Types::SchemaAttributeType]
@@ -311,6 +316,7 @@ module Aws::CognitoIdentityProvider
311
316
  attr_accessor session: ::String
312
317
  attr_accessor challenge_parameters: ::Hash[::String, ::String]
313
318
  attr_accessor authentication_result: Types::AuthenticationResultType
319
+ attr_accessor available_challenges: ::Array[("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")]
314
320
  SENSITIVE: [:session]
315
321
  end
316
322
 
@@ -616,6 +622,7 @@ module Aws::CognitoIdentityProvider
616
622
  attr_accessor provider_details: ::Hash[::String, ::String]
617
623
  attr_accessor attribute_mapping: ::Hash[::String, ::String]
618
624
  attr_accessor idp_identifiers: ::Array[::String]
625
+ attr_accessor acr_mapping: ::Hash[::String, ::String]
619
626
  SENSITIVE: []
620
627
  end
621
628
 
@@ -767,6 +774,7 @@ module Aws::CognitoIdentityProvider
767
774
  attr_accessor user_pool_tier: ("LITE" | "ESSENTIALS" | "PLUS")
768
775
  attr_accessor key_configuration: Types::KeyConfigurationType
769
776
  attr_accessor issuer_configuration: Types::IssuerConfigurationType
777
+ attr_accessor acr_configuration: ::Hash[::String, Types::AcrLevelConfigType]
770
778
  SENSITIVE: []
771
779
  end
772
780
 
@@ -1363,6 +1371,7 @@ module Aws::CognitoIdentityProvider
1363
1371
  attr_accessor provider_details: ::Hash[::String, ::String]
1364
1372
  attr_accessor attribute_mapping: ::Hash[::String, ::String]
1365
1373
  attr_accessor idp_identifiers: ::Array[::String]
1374
+ attr_accessor acr_mapping: ::Hash[::String, ::String]
1366
1375
  attr_accessor last_modified_date: ::Time
1367
1376
  attr_accessor creation_date: ::Time
1368
1377
  SENSITIVE: []
@@ -1875,6 +1884,7 @@ module Aws::CognitoIdentityProvider
1875
1884
  attr_accessor session: ::String
1876
1885
  attr_accessor challenge_parameters: ::Hash[::String, ::String]
1877
1886
  attr_accessor authentication_result: Types::AuthenticationResultType
1887
+ attr_accessor available_challenges: ::Array[("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")]
1878
1888
  SENSITIVE: [:session]
1879
1889
  end
1880
1890
 
@@ -2263,6 +2273,7 @@ module Aws::CognitoIdentityProvider
2263
2273
  attr_accessor provider_details: ::Hash[::String, ::String]
2264
2274
  attr_accessor attribute_mapping: ::Hash[::String, ::String]
2265
2275
  attr_accessor idp_identifiers: ::Array[::String]
2276
+ attr_accessor acr_mapping: ::Hash[::String, ::String]
2266
2277
  SENSITIVE: []
2267
2278
  end
2268
2279
 
@@ -2420,6 +2431,7 @@ module Aws::CognitoIdentityProvider
2420
2431
  attr_accessor user_pool_tier: ("LITE" | "ESSENTIALS" | "PLUS")
2421
2432
  attr_accessor key_configuration: Types::KeyConfigurationType
2422
2433
  attr_accessor issuer_configuration: Types::IssuerConfigurationType
2434
+ attr_accessor acr_configuration: ::Hash[::String, Types::AcrLevelConfigType]
2423
2435
  SENSITIVE: []
2424
2436
  end
2425
2437
 
@@ -2590,6 +2602,7 @@ module Aws::CognitoIdentityProvider
2590
2602
  attr_accessor user_pool_tier: ("LITE" | "ESSENTIALS" | "PLUS")
2591
2603
  attr_accessor key_configuration: Types::KeyConfigurationType
2592
2604
  attr_accessor issuer_configuration: Types::IssuerConfigurationType
2605
+ attr_accessor acr_configuration: ::Hash[::String, Types::AcrLevelConfigType]
2593
2606
  SENSITIVE: []
2594
2607
  end
2595
2608
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cognitoidentityprovider
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.153.0
4
+ version: 1.154.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services