aws-sdk-cognitoidentityprovider 1.46.0 → 1.51.0

Sign up to get free protection for your applications and to get access to all the features.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.51.0
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-cognitoidentityprovider/customizations'
48
48
  # @!group service
49
49
  module Aws::CognitoIdentityProvider
50
50
 
51
- GEM_VERSION = '1.46.0'
51
+ GEM_VERSION = '1.51.0'
52
52
 
53
53
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -1629,6 +1629,9 @@ module Aws::CognitoIdentityProvider
1629
1629
  # attributes, `USERNAME`, `SECRET_HASH` (if app client is configured
1630
1630
  # with client secret).
1631
1631
  #
1632
+ # * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
1633
+ # value returned by `VerifySoftwareToken` in the `Session` parameter.
1634
+ #
1632
1635
  # The value of the `USERNAME` attribute must be the user's actual
1633
1636
  # username, not an alias (such as email address or phone number). To
1634
1637
  # make this easier, the `AdminInitiateAuth` response includes the actual
@@ -2746,9 +2749,21 @@ module Aws::CognitoIdentityProvider
2746
2749
  #
2747
2750
  # @option params [String] :email_verification_message
2748
2751
  # A string representing the email verification message.
2752
+ # EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
2753
+ # is DEVELOPER.
2754
+ #
2755
+ #
2756
+ #
2757
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
2749
2758
  #
2750
2759
  # @option params [String] :email_verification_subject
2751
2760
  # A string representing the email verification subject.
2761
+ # EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
2762
+ # is DEVELOPER.
2763
+ #
2764
+ #
2765
+ #
2766
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
2752
2767
  #
2753
2768
  # @option params [Types::VerificationMessageTemplateType] :verification_message_template
2754
2769
  # The template for the verification message that the user sees when the
@@ -2834,6 +2849,15 @@ module Aws::CognitoIdentityProvider
2834
2849
  # verify_auth_challenge_response: "ArnType",
2835
2850
  # pre_token_generation: "ArnType",
2836
2851
  # user_migration: "ArnType",
2852
+ # custom_sms_sender: {
2853
+ # lambda_version: "V1_0", # required, accepts V1_0
2854
+ # lambda_arn: "ArnType", # required
2855
+ # },
2856
+ # custom_email_sender: {
2857
+ # lambda_version: "V1_0", # required, accepts V1_0
2858
+ # lambda_arn: "ArnType", # required
2859
+ # },
2860
+ # kms_key_id: "ArnType",
2837
2861
  # },
2838
2862
  # auto_verified_attributes: ["phone_number"], # accepts phone_number, email
2839
2863
  # alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
@@ -2931,6 +2955,11 @@ module Aws::CognitoIdentityProvider
2931
2955
  # resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
2932
2956
  # resp.user_pool.lambda_config.pre_token_generation #=> String
2933
2957
  # resp.user_pool.lambda_config.user_migration #=> String
2958
+ # resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
2959
+ # resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
2960
+ # resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
2961
+ # resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
2962
+ # resp.user_pool.lambda_config.kms_key_id #=> String
2934
2963
  # resp.user_pool.status #=> String, one of "Enabled", "Disabled"
2935
2964
  # resp.user_pool.last_modified_date #=> Time
2936
2965
  # resp.user_pool.creation_date #=> Time
@@ -3320,7 +3349,7 @@ module Aws::CognitoIdentityProvider
3320
3349
  req.send_request(options)
3321
3350
  end
3322
3351
 
3323
- # Deletes a group. Currently only groups with no members can be deleted.
3352
+ # Deletes a group.
3324
3353
  #
3325
3354
  # Calling this action requires developer credentials.
3326
3355
  #
@@ -3746,6 +3775,11 @@ module Aws::CognitoIdentityProvider
3746
3775
  # resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
3747
3776
  # resp.user_pool.lambda_config.pre_token_generation #=> String
3748
3777
  # resp.user_pool.lambda_config.user_migration #=> String
3778
+ # resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
3779
+ # resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
3780
+ # resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
3781
+ # resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
3782
+ # resp.user_pool.lambda_config.kms_key_id #=> String
3749
3783
  # resp.user_pool.status #=> String, one of "Enabled", "Disabled"
3750
3784
  # resp.user_pool.last_modified_date #=> Time
3751
3785
  # resp.user_pool.creation_date #=> Time
@@ -4997,6 +5031,11 @@ module Aws::CognitoIdentityProvider
4997
5031
  # resp.user_pools[0].lambda_config.verify_auth_challenge_response #=> String
4998
5032
  # resp.user_pools[0].lambda_config.pre_token_generation #=> String
4999
5033
  # resp.user_pools[0].lambda_config.user_migration #=> String
5034
+ # resp.user_pools[0].lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
5035
+ # resp.user_pools[0].lambda_config.custom_sms_sender.lambda_arn #=> String
5036
+ # resp.user_pools[0].lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
5037
+ # resp.user_pools[0].lambda_config.custom_email_sender.lambda_arn #=> String
5038
+ # resp.user_pools[0].lambda_config.kms_key_id #=> String
5000
5039
  # resp.user_pools[0].status #=> String, one of "Enabled", "Disabled"
5001
5040
  # resp.user_pools[0].last_modified_date #=> Time
5002
5041
  # resp.user_pools[0].creation_date #=> Time
@@ -5330,6 +5369,9 @@ module Aws::CognitoIdentityProvider
5330
5369
  # * `DEVICE_PASSWORD_VERIFIER` requires everything that
5331
5370
  # `PASSWORD_VERIFIER` requires plus `DEVICE_KEY`.
5332
5371
  #
5372
+ # * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
5373
+ # value returned by `VerifySoftwareToken` in the `Session` parameter.
5374
+ #
5333
5375
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
5334
5376
  # The Amazon Pinpoint analytics metadata for collecting metrics for
5335
5377
  # `RespondToAuthChallenge` calls.
@@ -5619,7 +5661,12 @@ module Aws::CognitoIdentityProvider
5619
5661
  # one factor can be set as preferred. The preferred MFA factor will be
5620
5662
  # used to authenticate a user if multiple factors are enabled. If
5621
5663
  # multiple options are enabled and no preference is set, a challenge to
5622
- # choose an MFA option will be returned during sign in.
5664
+ # choose an MFA option will be returned during sign in. If an MFA type
5665
+ # is enabled for a user, the user will be prompted for MFA during all
5666
+ # sign in attempts, unless device tracking is turned on and the device
5667
+ # has been trusted. If you would like MFA to be applied selectively
5668
+ # based on the assessed risk level of sign in attempts, disable MFA for
5669
+ # users and turn on Adaptive Authentication for the user pool.
5623
5670
  #
5624
5671
  # @option params [Types::SMSMfaSettingsType] :sms_mfa_settings
5625
5672
  # The SMS text message multi-factor authentication (MFA) settings.
@@ -5667,7 +5714,11 @@ module Aws::CognitoIdentityProvider
5667
5714
  # The software token MFA configuration.
5668
5715
  #
5669
5716
  # @option params [String] :mfa_configuration
5670
- # The MFA configuration. Valid values include:
5717
+ # The MFA configuration. Users who don't have an MFA factor set up
5718
+ # won't be able to sign-in if you set the MfaConfiguration value to
5719
+ # ‘ON’. See [Adding Multi-Factor Authentication (MFA) to a User
5720
+ # Pool](cognito/latest/developerguide/user-pool-settings-mfa.html) to
5721
+ # learn more. Valid values include:
5671
5722
  #
5672
5723
  # * `OFF` MFA will not be used for any users.
5673
5724
  #
@@ -6420,11 +6471,17 @@ module Aws::CognitoIdentityProvider
6420
6471
  # user registration.
6421
6472
  #
6422
6473
  # * `ON` - MFA tokens are required for all user registrations. You can
6423
- # only specify required when you are initially creating a user pool.
6474
+ # only specify ON when you are initially creating a user pool. You can
6475
+ # use the [SetUserPoolMfaConfig][1] API operation to turn MFA "ON"
6476
+ # for existing user pools.
6424
6477
  #
6425
6478
  # * `OPTIONAL` - Users have the option when registering to create an MFA
6426
6479
  # token.
6427
6480
  #
6481
+ #
6482
+ #
6483
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
6484
+ #
6428
6485
  # @option params [Types::DeviceConfigurationType] :device_configuration
6429
6486
  # Device configuration.
6430
6487
  #
@@ -6482,6 +6539,15 @@ module Aws::CognitoIdentityProvider
6482
6539
  # verify_auth_challenge_response: "ArnType",
6483
6540
  # pre_token_generation: "ArnType",
6484
6541
  # user_migration: "ArnType",
6542
+ # custom_sms_sender: {
6543
+ # lambda_version: "V1_0", # required, accepts V1_0
6544
+ # lambda_arn: "ArnType", # required
6545
+ # },
6546
+ # custom_email_sender: {
6547
+ # lambda_version: "V1_0", # required, accepts V1_0
6548
+ # lambda_arn: "ArnType", # required
6549
+ # },
6550
+ # kms_key_id: "ArnType",
6485
6551
  # },
6486
6552
  # auto_verified_attributes: ["phone_number"], # accepts phone_number, email
6487
6553
  # sms_verification_message: "SmsVerificationMessageType",
@@ -6982,7 +7048,7 @@ module Aws::CognitoIdentityProvider
6982
7048
  params: params,
6983
7049
  config: config)
6984
7050
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
6985
- context[:gem_version] = '1.46.0'
7051
+ context[:gem_version] = '1.51.0'
6986
7052
  Seahorse::Client::Request.new(handlers, context)
6987
7053
  end
6988
7054
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -149,6 +149,10 @@ module Aws::CognitoIdentityProvider
149
149
  CustomAttributeNameType = Shapes::StringShape.new(name: 'CustomAttributeNameType')
150
150
  CustomAttributesListType = Shapes::ListShape.new(name: 'CustomAttributesListType')
151
151
  CustomDomainConfigType = Shapes::StructureShape.new(name: 'CustomDomainConfigType')
152
+ CustomEmailLambdaVersionConfigType = Shapes::StructureShape.new(name: 'CustomEmailLambdaVersionConfigType')
153
+ CustomEmailSenderLambdaVersionType = Shapes::StringShape.new(name: 'CustomEmailSenderLambdaVersionType')
154
+ CustomSMSLambdaVersionConfigType = Shapes::StructureShape.new(name: 'CustomSMSLambdaVersionConfigType')
155
+ CustomSMSSenderLambdaVersionType = Shapes::StringShape.new(name: 'CustomSMSSenderLambdaVersionType')
152
156
  DateType = Shapes::TimestampShape.new(name: 'DateType')
153
157
  DefaultEmailOptionType = Shapes::StringShape.new(name: 'DefaultEmailOptionType')
154
158
  DeleteGroupRequest = Shapes::StructureShape.new(name: 'DeleteGroupRequest')
@@ -957,6 +961,14 @@ module Aws::CognitoIdentityProvider
957
961
  CustomDomainConfigType.add_member(:certificate_arn, Shapes::ShapeRef.new(shape: ArnType, required: true, location_name: "CertificateArn"))
958
962
  CustomDomainConfigType.struct_class = Types::CustomDomainConfigType
959
963
 
964
+ CustomEmailLambdaVersionConfigType.add_member(:lambda_version, Shapes::ShapeRef.new(shape: CustomEmailSenderLambdaVersionType, required: true, location_name: "LambdaVersion"))
965
+ CustomEmailLambdaVersionConfigType.add_member(:lambda_arn, Shapes::ShapeRef.new(shape: ArnType, required: true, location_name: "LambdaArn"))
966
+ CustomEmailLambdaVersionConfigType.struct_class = Types::CustomEmailLambdaVersionConfigType
967
+
968
+ CustomSMSLambdaVersionConfigType.add_member(:lambda_version, Shapes::ShapeRef.new(shape: CustomSMSSenderLambdaVersionType, required: true, location_name: "LambdaVersion"))
969
+ CustomSMSLambdaVersionConfigType.add_member(:lambda_arn, Shapes::ShapeRef.new(shape: ArnType, required: true, location_name: "LambdaArn"))
970
+ CustomSMSLambdaVersionConfigType.struct_class = Types::CustomSMSLambdaVersionConfigType
971
+
960
972
  DeleteGroupRequest.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupNameType, required: true, location_name: "GroupName"))
961
973
  DeleteGroupRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
962
974
  DeleteGroupRequest.struct_class = Types::DeleteGroupRequest
@@ -1274,6 +1286,9 @@ module Aws::CognitoIdentityProvider
1274
1286
  LambdaConfigType.add_member(:verify_auth_challenge_response, Shapes::ShapeRef.new(shape: ArnType, location_name: "VerifyAuthChallengeResponse"))
1275
1287
  LambdaConfigType.add_member(:pre_token_generation, Shapes::ShapeRef.new(shape: ArnType, location_name: "PreTokenGeneration"))
1276
1288
  LambdaConfigType.add_member(:user_migration, Shapes::ShapeRef.new(shape: ArnType, location_name: "UserMigration"))
1289
+ LambdaConfigType.add_member(:custom_sms_sender, Shapes::ShapeRef.new(shape: CustomSMSLambdaVersionConfigType, location_name: "CustomSMSSender"))
1290
+ LambdaConfigType.add_member(:custom_email_sender, Shapes::ShapeRef.new(shape: CustomEmailLambdaVersionConfigType, location_name: "CustomEmailSender"))
1291
+ LambdaConfigType.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: ArnType, location_name: "KMSKeyID"))
1277
1292
  LambdaConfigType.struct_class = Types::LambdaConfigType
1278
1293
 
1279
1294
  LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: MessageType, location_name: "message"))
@@ -2,7 +2,7 @@
2
2
  # WARNING ABOUT GENERATED CODE
3
3
  #
4
4
  # This file is generated. See the contributing for info on making contributions:
5
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
6
6
  #
7
7
  # WARNING ABOUT GENERATED CODE
8
8
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -705,7 +705,7 @@ module Aws::CognitoIdentityProvider
705
705
  #
706
706
  class AdminDisableProviderForUserResponse < Aws::EmptyStructure; end
707
707
 
708
- # Represents the request to disable any user as an administrator.
708
+ # Represents the request to disable the user as an administrator.
709
709
  #
710
710
  # @note When making an API call, you may pass AdminDisableUserRequest
711
711
  # data as a hash:
@@ -1191,10 +1191,22 @@ module Aws::CognitoIdentityProvider
1191
1191
  # with `USERNAME` and `PASSWORD` directly. An app client must be
1192
1192
  # enabled to use this flow.
1193
1193
  #
1194
- # * `NEW_PASSWORD_REQUIRED`\: For users which are required to change
1194
+ # * `NEW_PASSWORD_REQUIRED`\: For users who are required to change
1195
1195
  # their passwords after successful first login. This challenge
1196
1196
  # should be passed with `NEW_PASSWORD` and any other required
1197
1197
  # attributes.
1198
+ #
1199
+ # * `MFA_SETUP`\: For users who are required to setup an MFA factor
1200
+ # before they can sign-in. The MFA types enabled for the user pool
1201
+ # will be listed in the challenge parameters `MFA_CAN_SETUP` value.
1202
+ #
1203
+ # To setup software token MFA, use the session returned here from
1204
+ # `InitiateAuth` as an input to `AssociateSoftwareToken`, and use
1205
+ # the session returned by `VerifySoftwareToken` as an input to
1206
+ # `RespondToAuthChallenge` with challenge name `MFA_SETUP` to
1207
+ # complete sign-in. To setup SMS MFA, users will need help from an
1208
+ # administrator to add a phone number to their account and then call
1209
+ # `InitiateAuth` again to restart sign-in.
1198
1210
  # @return [String]
1199
1211
  #
1200
1212
  # @!attribute [rw] session
@@ -1671,6 +1683,10 @@ module Aws::CognitoIdentityProvider
1671
1683
  # attributes, `USERNAME`, `SECRET_HASH` (if app client is configured
1672
1684
  # with client secret).
1673
1685
  #
1686
+ # * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
1687
+ # value returned by `VerifySoftwareToken` in the `Session`
1688
+ # parameter.
1689
+ #
1674
1690
  # The value of the `USERNAME` attribute must be the user's actual
1675
1691
  # username, not an alias (such as email address or phone number). To
1676
1692
  # make this easier, the `AdminInitiateAuth` response includes the
@@ -3628,6 +3644,15 @@ module Aws::CognitoIdentityProvider
3628
3644
  # verify_auth_challenge_response: "ArnType",
3629
3645
  # pre_token_generation: "ArnType",
3630
3646
  # user_migration: "ArnType",
3647
+ # custom_sms_sender: {
3648
+ # lambda_version: "V1_0", # required, accepts V1_0
3649
+ # lambda_arn: "ArnType", # required
3650
+ # },
3651
+ # custom_email_sender: {
3652
+ # lambda_version: "V1_0", # required, accepts V1_0
3653
+ # lambda_arn: "ArnType", # required
3654
+ # },
3655
+ # kms_key_id: "ArnType",
3631
3656
  # },
3632
3657
  # auto_verified_attributes: ["phone_number"], # accepts phone_number, email
3633
3658
  # alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
@@ -3757,10 +3782,22 @@ module Aws::CognitoIdentityProvider
3757
3782
  #
3758
3783
  # @!attribute [rw] email_verification_message
3759
3784
  # A string representing the email verification message.
3785
+ # EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
3786
+ # is DEVELOPER.
3787
+ #
3788
+ #
3789
+ #
3790
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
3760
3791
  # @return [String]
3761
3792
  #
3762
3793
  # @!attribute [rw] email_verification_subject
3763
3794
  # A string representing the email verification subject.
3795
+ # EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
3796
+ # is DEVELOPER.
3797
+ #
3798
+ #
3799
+ #
3800
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
3764
3801
  # @return [String]
3765
3802
  #
3766
3803
  # @!attribute [rw] verification_message_template
@@ -3898,6 +3935,66 @@ module Aws::CognitoIdentityProvider
3898
3935
  include Aws::Structure
3899
3936
  end
3900
3937
 
3938
+ # A custom email sender Lambda configuration type.
3939
+ #
3940
+ # @note When making an API call, you may pass CustomEmailLambdaVersionConfigType
3941
+ # data as a hash:
3942
+ #
3943
+ # {
3944
+ # lambda_version: "V1_0", # required, accepts V1_0
3945
+ # lambda_arn: "ArnType", # required
3946
+ # }
3947
+ #
3948
+ # @!attribute [rw] lambda_version
3949
+ # The Lambda version represents the signature of the "request"
3950
+ # attribute in the "event" information Amazon Cognito passes to your
3951
+ # custom email Lambda function. The only supported value is `V1_0`.
3952
+ # @return [String]
3953
+ #
3954
+ # @!attribute [rw] lambda_arn
3955
+ # The Lambda Amazon Resource Name of the Lambda function that Amazon
3956
+ # Cognito triggers to send email notifications to users.
3957
+ # @return [String]
3958
+ #
3959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CustomEmailLambdaVersionConfigType AWS API Documentation
3960
+ #
3961
+ class CustomEmailLambdaVersionConfigType < Struct.new(
3962
+ :lambda_version,
3963
+ :lambda_arn)
3964
+ SENSITIVE = []
3965
+ include Aws::Structure
3966
+ end
3967
+
3968
+ # A custom SMS sender Lambda configuration type.
3969
+ #
3970
+ # @note When making an API call, you may pass CustomSMSLambdaVersionConfigType
3971
+ # data as a hash:
3972
+ #
3973
+ # {
3974
+ # lambda_version: "V1_0", # required, accepts V1_0
3975
+ # lambda_arn: "ArnType", # required
3976
+ # }
3977
+ #
3978
+ # @!attribute [rw] lambda_version
3979
+ # The Lambda version represents the signature of the "request"
3980
+ # attribute in the "event" information Amazon Cognito passes to your
3981
+ # custom SMS Lambda function. The only supported value is `V1_0`.
3982
+ # @return [String]
3983
+ #
3984
+ # @!attribute [rw] lambda_arn
3985
+ # The Lambda Amazon Resource Name of the Lambda function that Amazon
3986
+ # Cognito triggers to send SMS notifications to users.
3987
+ # @return [String]
3988
+ #
3989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CustomSMSLambdaVersionConfigType AWS API Documentation
3990
+ #
3991
+ class CustomSMSLambdaVersionConfigType < Struct.new(
3992
+ :lambda_version,
3993
+ :lambda_arn)
3994
+ SENSITIVE = []
3995
+ include Aws::Structure
3996
+ end
3997
+
3901
3998
  # @note When making an API call, you may pass DeleteGroupRequest
3902
3999
  # data as a hash:
3903
4000
  #
@@ -4528,6 +4625,16 @@ module Aws::CognitoIdentityProvider
4528
4625
 
4529
4626
  # The email configuration type.
4530
4627
  #
4628
+ # <note markdown="1"> Amazon Cognito has specific regions for use with Amazon SES. For more
4629
+ # information on the supported regions, see [Email Settings for Amazon
4630
+ # Cognito User Pools][1].
4631
+ #
4632
+ # </note>
4633
+ #
4634
+ #
4635
+ #
4636
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html
4637
+ #
4531
4638
  # @note When making an API call, you may pass EmailConfigurationType
4532
4639
  # data as a hash:
4533
4640
  #
@@ -4580,6 +4687,29 @@ module Aws::CognitoIdentityProvider
4580
4687
  # customize the FROM address, provide the ARN of an Amazon SES
4581
4688
  # verified email address for the `SourceArn` parameter.
4582
4689
  #
4690
+ # If EmailSendingAccount is COGNITO\_DEFAULT, the following
4691
+ # parameters aren't allowed:
4692
+ #
4693
+ # * EmailVerificationMessage
4694
+ #
4695
+ # * EmailVerificationSubject
4696
+ #
4697
+ # * InviteMessageTemplate.EmailMessage
4698
+ #
4699
+ # * InviteMessageTemplate.EmailSubject
4700
+ #
4701
+ # * VerificationMessageTemplate.EmailMessage
4702
+ #
4703
+ # * VerificationMessageTemplate.EmailMessageByLink
4704
+ #
4705
+ # * VerificationMessageTemplate.EmailSubject,
4706
+ #
4707
+ # * VerificationMessageTemplate.EmailSubjectByLink
4708
+ #
4709
+ # <note markdown="1"> DEVELOPER EmailSendingAccount is required.
4710
+ #
4711
+ # </note>
4712
+ #
4583
4713
  # DEVELOPER
4584
4714
  #
4585
4715
  # : When Amazon Cognito emails your users, it uses your Amazon SES
@@ -5775,10 +5905,22 @@ module Aws::CognitoIdentityProvider
5775
5905
  # * `DEVICE_PASSWORD_VERIFIER`\: Similar to `PASSWORD_VERIFIER`, but
5776
5906
  # for devices only.
5777
5907
  #
5778
- # * `NEW_PASSWORD_REQUIRED`\: For users which are required to change
5908
+ # * `NEW_PASSWORD_REQUIRED`\: For users who are required to change
5779
5909
  # their passwords after successful first login. This challenge
5780
5910
  # should be passed with `NEW_PASSWORD` and any other required
5781
5911
  # attributes.
5912
+ #
5913
+ # * `MFA_SETUP`\: For users who are required to setup an MFA factor
5914
+ # before they can sign-in. The MFA types enabled for the user pool
5915
+ # will be listed in the challenge parameters `MFA_CAN_SETUP` value.
5916
+ #
5917
+ # To setup software token MFA, use the session returned here from
5918
+ # `InitiateAuth` as an input to `AssociateSoftwareToken`, and use
5919
+ # the session returned by `VerifySoftwareToken` as an input to
5920
+ # `RespondToAuthChallenge` with challenge name `MFA_SETUP` to
5921
+ # complete sign-in. To setup SMS MFA, users will need help from an
5922
+ # administrator to add a phone number to their account and then call
5923
+ # `InitiateAuth` again to restart sign-in.
5782
5924
  # @return [String]
5783
5925
  #
5784
5926
  # @!attribute [rw] session
@@ -5975,6 +6117,15 @@ module Aws::CognitoIdentityProvider
5975
6117
  # verify_auth_challenge_response: "ArnType",
5976
6118
  # pre_token_generation: "ArnType",
5977
6119
  # user_migration: "ArnType",
6120
+ # custom_sms_sender: {
6121
+ # lambda_version: "V1_0", # required, accepts V1_0
6122
+ # lambda_arn: "ArnType", # required
6123
+ # },
6124
+ # custom_email_sender: {
6125
+ # lambda_version: "V1_0", # required, accepts V1_0
6126
+ # lambda_arn: "ArnType", # required
6127
+ # },
6128
+ # kms_key_id: "ArnType",
5978
6129
  # }
5979
6130
  #
5980
6131
  # @!attribute [rw] pre_sign_up
@@ -6017,6 +6168,21 @@ module Aws::CognitoIdentityProvider
6017
6168
  # The user migration Lambda config type.
6018
6169
  # @return [String]
6019
6170
  #
6171
+ # @!attribute [rw] custom_sms_sender
6172
+ # A custom SMS sender AWS Lambda trigger.
6173
+ # @return [Types::CustomSMSLambdaVersionConfigType]
6174
+ #
6175
+ # @!attribute [rw] custom_email_sender
6176
+ # A custom email sender AWS Lambda trigger.
6177
+ # @return [Types::CustomEmailLambdaVersionConfigType]
6178
+ #
6179
+ # @!attribute [rw] kms_key_id
6180
+ # The Amazon Resource Name of Key Management Service [Customer master
6181
+ # keys](/kms/latest/developerguide/concepts.html#master_keys) . Amazon
6182
+ # Cognito uses the key to encrypt codes and temporary passwords sent
6183
+ # to `CustomEmailSender` and `CustomSMSSender`.
6184
+ # @return [String]
6185
+ #
6020
6186
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/LambdaConfigType AWS API Documentation
6021
6187
  #
6022
6188
  class LambdaConfigType < Struct.new(
@@ -6029,7 +6195,10 @@ module Aws::CognitoIdentityProvider
6029
6195
  :create_auth_challenge,
6030
6196
  :verify_auth_challenge_response,
6031
6197
  :pre_token_generation,
6032
- :user_migration)
6198
+ :user_migration,
6199
+ :custom_sms_sender,
6200
+ :custom_email_sender,
6201
+ :kms_key_id)
6033
6202
  SENSITIVE = []
6034
6203
  include Aws::Structure
6035
6204
  end
@@ -6690,11 +6859,21 @@ module Aws::CognitoIdentityProvider
6690
6859
  # @return [String]
6691
6860
  #
6692
6861
  # @!attribute [rw] email_message
6693
- # The message template for email messages.
6862
+ # The message template for email messages. EmailMessage is allowed
6863
+ # only if [EmailSendingAccount][1] is DEVELOPER.
6864
+ #
6865
+ #
6866
+ #
6867
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
6694
6868
  # @return [String]
6695
6869
  #
6696
6870
  # @!attribute [rw] email_subject
6697
- # The subject line for email messages.
6871
+ # The subject line for email messages. EmailSubject is allowed only if
6872
+ # [EmailSendingAccount][1] is DEVELOPER.
6873
+ #
6874
+ #
6875
+ #
6876
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
6698
6877
  # @return [String]
6699
6878
  #
6700
6879
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MessageTemplateType AWS API Documentation
@@ -7316,6 +7495,10 @@ module Aws::CognitoIdentityProvider
7316
7495
  #
7317
7496
  # * `DEVICE_PASSWORD_VERIFIER` requires everything that
7318
7497
  # `PASSWORD_VERIFIER` requires plus `DEVICE_KEY`.
7498
+ #
7499
+ # * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
7500
+ # value returned by `VerifySoftwareToken` in the `Session`
7501
+ # parameter.
7319
7502
  # @return [Hash<String,String>]
7320
7503
  #
7321
7504
  # @!attribute [rw] analytics_metadata
@@ -7499,7 +7682,13 @@ module Aws::CognitoIdentityProvider
7499
7682
  include Aws::Structure
7500
7683
  end
7501
7684
 
7502
- # The type used for enabling SMS MFA at the user level.
7685
+ # The type used for enabling SMS MFA at the user level. Phone numbers
7686
+ # don't need to be verified to be used for SMS MFA. If an MFA type is
7687
+ # enabled for a user, the user will be prompted for MFA during all sign
7688
+ # in attempts, unless device tracking is turned on and the device has
7689
+ # been trusted. If you would like MFA to be applied selectively based on
7690
+ # the assessed risk level of sign in attempts, disable MFA for users and
7691
+ # turn on Adaptive Authentication for the user pool.
7503
7692
  #
7504
7693
  # @note When making an API call, you may pass SMSMfaSettingsType
7505
7694
  # data as a hash:
@@ -7510,7 +7699,10 @@ module Aws::CognitoIdentityProvider
7510
7699
  # }
7511
7700
  #
7512
7701
  # @!attribute [rw] enabled
7513
- # Specifies whether SMS text message MFA is enabled.
7702
+ # Specifies whether SMS text message MFA is enabled. If an MFA type is
7703
+ # enabled for a user, the user will be prompted for MFA during all
7704
+ # sign in attempts, unless device tracking is turned on and the device
7705
+ # has been trusted.
7514
7706
  # @return [Boolean]
7515
7707
  #
7516
7708
  # @!attribute [rw] preferred_mfa
@@ -7857,7 +8049,11 @@ module Aws::CognitoIdentityProvider
7857
8049
  # @return [Types::SoftwareTokenMfaConfigType]
7858
8050
  #
7859
8051
  # @!attribute [rw] mfa_configuration
7860
- # The MFA configuration. Valid values include:
8052
+ # The MFA configuration. Users who don't have an MFA factor set up
8053
+ # won't be able to sign-in if you set the MfaConfiguration value to
8054
+ # ‘ON’. See [Adding Multi-Factor Authentication (MFA) to a User
8055
+ # Pool](cognito/latest/developerguide/user-pool-settings-mfa.html) to
8056
+ # learn more. Valid values include:
7861
8057
  #
7862
8058
  # * `OFF` MFA will not be used for any users.
7863
8059
  #
@@ -8119,7 +8315,12 @@ module Aws::CognitoIdentityProvider
8119
8315
  # @!attribute [rw] sns_caller_arn
8120
8316
  # The Amazon Resource Name (ARN) of the Amazon Simple Notification
8121
8317
  # Service (SNS) caller. This is the ARN of the IAM role in your AWS
8122
- # account which Cognito will use to send SMS messages.
8318
+ # account which Cognito will use to send SMS messages. SMS messages
8319
+ # are subject to a [spending limit][1].
8320
+ #
8321
+ #
8322
+ #
8323
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html
8123
8324
  # @return [String]
8124
8325
  #
8125
8326
  # @!attribute [rw] external_id
@@ -8132,6 +8333,14 @@ module Aws::CognitoIdentityProvider
8132
8333
  # role for SMS MFA, Cognito will create a role with the required
8133
8334
  # permissions and a trust policy that demonstrates use of the
8134
8335
  # `ExternalId`.
8336
+ #
8337
+ # For more information about the `ExternalId` of a role, see [How to
8338
+ # use an external ID when granting access to your AWS resources to a
8339
+ # third party][1]
8340
+ #
8341
+ #
8342
+ #
8343
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
8135
8344
  # @return [String]
8136
8345
  #
8137
8346
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SmsConfigurationType AWS API Documentation
@@ -8212,7 +8421,13 @@ module Aws::CognitoIdentityProvider
8212
8421
  include Aws::Structure
8213
8422
  end
8214
8423
 
8215
- # The type used for enabling software token MFA at the user level.
8424
+ # The type used for enabling software token MFA at the user level. If an
8425
+ # MFA type is enabled for a user, the user will be prompted for MFA
8426
+ # during all sign in attempts, unless device tracking is turned on and
8427
+ # the device has been trusted. If you would like MFA to be applied
8428
+ # selectively based on the assessed risk level of sign in attempts,
8429
+ # disable MFA for users and turn on Adaptive Authentication for the user
8430
+ # pool.
8216
8431
  #
8217
8432
  # @note When making an API call, you may pass SoftwareTokenMfaSettingsType
8218
8433
  # data as a hash:
@@ -8223,7 +8438,10 @@ module Aws::CognitoIdentityProvider
8223
8438
  # }
8224
8439
  #
8225
8440
  # @!attribute [rw] enabled
8226
- # Specifies whether software token MFA is enabled.
8441
+ # Specifies whether software token MFA is enabled. If an MFA type is
8442
+ # enabled for a user, the user will be prompted for MFA during all
8443
+ # sign in attempts, unless device tracking is turned on and the device
8444
+ # has been trusted.
8227
8445
  # @return [Boolean]
8228
8446
  #
8229
8447
  # @!attribute [rw] preferred_mfa
@@ -9281,6 +9499,15 @@ module Aws::CognitoIdentityProvider
9281
9499
  # verify_auth_challenge_response: "ArnType",
9282
9500
  # pre_token_generation: "ArnType",
9283
9501
  # user_migration: "ArnType",
9502
+ # custom_sms_sender: {
9503
+ # lambda_version: "V1_0", # required, accepts V1_0
9504
+ # lambda_arn: "ArnType", # required
9505
+ # },
9506
+ # custom_email_sender: {
9507
+ # lambda_version: "V1_0", # required, accepts V1_0
9508
+ # lambda_arn: "ArnType", # required
9509
+ # },
9510
+ # kms_key_id: "ArnType",
9284
9511
  # },
9285
9512
  # auto_verified_attributes: ["phone_number"], # accepts phone_number, email
9286
9513
  # sms_verification_message: "SmsVerificationMessageType",
@@ -9381,10 +9608,16 @@ module Aws::CognitoIdentityProvider
9381
9608
  # user registration.
9382
9609
  #
9383
9610
  # * `ON` - MFA tokens are required for all user registrations. You can
9384
- # only specify required when you are initially creating a user pool.
9611
+ # only specify ON when you are initially creating a user pool. You
9612
+ # can use the [SetUserPoolMfaConfig][1] API operation to turn MFA
9613
+ # "ON" for existing user pools.
9385
9614
  #
9386
9615
  # * `OPTIONAL` - Users have the option when registering to create an
9387
9616
  # MFA token.
9617
+ #
9618
+ #
9619
+ #
9620
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
9388
9621
  # @return [String]
9389
9622
  #
9390
9623
  # @!attribute [rw] device_configuration
@@ -10347,21 +10580,41 @@ module Aws::CognitoIdentityProvider
10347
10580
  # @return [String]
10348
10581
  #
10349
10582
  # @!attribute [rw] email_message
10350
- # The email message template.
10583
+ # The email message template. EmailMessage is allowed only if [
10584
+ # EmailSendingAccount][1] is DEVELOPER.
10585
+ #
10586
+ #
10587
+ #
10588
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10351
10589
  # @return [String]
10352
10590
  #
10353
10591
  # @!attribute [rw] email_subject
10354
- # The subject line for the email message template.
10592
+ # The subject line for the email message template. EmailSubject is
10593
+ # allowed only if [EmailSendingAccount][1] is DEVELOPER.
10594
+ #
10595
+ #
10596
+ #
10597
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10355
10598
  # @return [String]
10356
10599
  #
10357
10600
  # @!attribute [rw] email_message_by_link
10358
10601
  # The email message template for sending a confirmation link to the
10359
- # user.
10602
+ # user. EmailMessageByLink is allowed only if [
10603
+ # EmailSendingAccount][1] is DEVELOPER.
10604
+ #
10605
+ #
10606
+ #
10607
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10360
10608
  # @return [String]
10361
10609
  #
10362
10610
  # @!attribute [rw] email_subject_by_link
10363
10611
  # The subject line for the email message template for sending a
10364
- # confirmation link to the user.
10612
+ # confirmation link to the user. EmailSubjectByLink is allowed only [
10613
+ # EmailSendingAccount][1] is DEVELOPER.
10614
+ #
10615
+ #
10616
+ #
10617
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10365
10618
  # @return [String]
10366
10619
  #
10367
10620
  # @!attribute [rw] default_email_option