aws-sdk-cognitoidentityprovider 1.47.0 → 1.52.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.
@@ -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
@@ -5534,8 +5664,6 @@ module Aws::CognitoIdentityProvider
5534
5664
  # * jwks\_uri *if not available from discovery URL specified by
5535
5665
  # oidc\_issuer key*
5536
5666
  #
5537
- # * authorize\_scopes
5538
- #
5539
5667
  # * For SAML providers:
5540
5668
  #
5541
5669
  # * MetadataFile OR MetadataURL
@@ -5775,10 +5903,22 @@ module Aws::CognitoIdentityProvider
5775
5903
  # * `DEVICE_PASSWORD_VERIFIER`\: Similar to `PASSWORD_VERIFIER`, but
5776
5904
  # for devices only.
5777
5905
  #
5778
- # * `NEW_PASSWORD_REQUIRED`\: For users which are required to change
5906
+ # * `NEW_PASSWORD_REQUIRED`\: For users who are required to change
5779
5907
  # their passwords after successful first login. This challenge
5780
5908
  # should be passed with `NEW_PASSWORD` and any other required
5781
5909
  # attributes.
5910
+ #
5911
+ # * `MFA_SETUP`\: For users who are required to setup an MFA factor
5912
+ # before they can sign-in. The MFA types enabled for the user pool
5913
+ # will be listed in the challenge parameters `MFA_CAN_SETUP` value.
5914
+ #
5915
+ # To setup software token MFA, use the session returned here from
5916
+ # `InitiateAuth` as an input to `AssociateSoftwareToken`, and use
5917
+ # the session returned by `VerifySoftwareToken` as an input to
5918
+ # `RespondToAuthChallenge` with challenge name `MFA_SETUP` to
5919
+ # complete sign-in. To setup SMS MFA, users will need help from an
5920
+ # administrator to add a phone number to their account and then call
5921
+ # `InitiateAuth` again to restart sign-in.
5782
5922
  # @return [String]
5783
5923
  #
5784
5924
  # @!attribute [rw] session
@@ -5975,6 +6115,15 @@ module Aws::CognitoIdentityProvider
5975
6115
  # verify_auth_challenge_response: "ArnType",
5976
6116
  # pre_token_generation: "ArnType",
5977
6117
  # user_migration: "ArnType",
6118
+ # custom_sms_sender: {
6119
+ # lambda_version: "V1_0", # required, accepts V1_0
6120
+ # lambda_arn: "ArnType", # required
6121
+ # },
6122
+ # custom_email_sender: {
6123
+ # lambda_version: "V1_0", # required, accepts V1_0
6124
+ # lambda_arn: "ArnType", # required
6125
+ # },
6126
+ # kms_key_id: "ArnType",
5978
6127
  # }
5979
6128
  #
5980
6129
  # @!attribute [rw] pre_sign_up
@@ -6017,6 +6166,21 @@ module Aws::CognitoIdentityProvider
6017
6166
  # The user migration Lambda config type.
6018
6167
  # @return [String]
6019
6168
  #
6169
+ # @!attribute [rw] custom_sms_sender
6170
+ # A custom SMS sender AWS Lambda trigger.
6171
+ # @return [Types::CustomSMSLambdaVersionConfigType]
6172
+ #
6173
+ # @!attribute [rw] custom_email_sender
6174
+ # A custom email sender AWS Lambda trigger.
6175
+ # @return [Types::CustomEmailLambdaVersionConfigType]
6176
+ #
6177
+ # @!attribute [rw] kms_key_id
6178
+ # The Amazon Resource Name of Key Management Service [Customer master
6179
+ # keys](/kms/latest/developerguide/concepts.html#master_keys) . Amazon
6180
+ # Cognito uses the key to encrypt codes and temporary passwords sent
6181
+ # to `CustomEmailSender` and `CustomSMSSender`.
6182
+ # @return [String]
6183
+ #
6020
6184
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/LambdaConfigType AWS API Documentation
6021
6185
  #
6022
6186
  class LambdaConfigType < Struct.new(
@@ -6029,7 +6193,10 @@ module Aws::CognitoIdentityProvider
6029
6193
  :create_auth_challenge,
6030
6194
  :verify_auth_challenge_response,
6031
6195
  :pre_token_generation,
6032
- :user_migration)
6196
+ :user_migration,
6197
+ :custom_sms_sender,
6198
+ :custom_email_sender,
6199
+ :kms_key_id)
6033
6200
  SENSITIVE = []
6034
6201
  include Aws::Structure
6035
6202
  end
@@ -6690,11 +6857,21 @@ module Aws::CognitoIdentityProvider
6690
6857
  # @return [String]
6691
6858
  #
6692
6859
  # @!attribute [rw] email_message
6693
- # The message template for email messages.
6860
+ # The message template for email messages. EmailMessage is allowed
6861
+ # only if [EmailSendingAccount][1] is DEVELOPER.
6862
+ #
6863
+ #
6864
+ #
6865
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
6694
6866
  # @return [String]
6695
6867
  #
6696
6868
  # @!attribute [rw] email_subject
6697
- # The subject line for email messages.
6869
+ # The subject line for email messages. EmailSubject is allowed only if
6870
+ # [EmailSendingAccount][1] is DEVELOPER.
6871
+ #
6872
+ #
6873
+ #
6874
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
6698
6875
  # @return [String]
6699
6876
  #
6700
6877
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MessageTemplateType AWS API Documentation
@@ -7316,6 +7493,10 @@ module Aws::CognitoIdentityProvider
7316
7493
  #
7317
7494
  # * `DEVICE_PASSWORD_VERIFIER` requires everything that
7318
7495
  # `PASSWORD_VERIFIER` requires plus `DEVICE_KEY`.
7496
+ #
7497
+ # * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
7498
+ # value returned by `VerifySoftwareToken` in the `Session`
7499
+ # parameter.
7319
7500
  # @return [Hash<String,String>]
7320
7501
  #
7321
7502
  # @!attribute [rw] analytics_metadata
@@ -7499,7 +7680,13 @@ module Aws::CognitoIdentityProvider
7499
7680
  include Aws::Structure
7500
7681
  end
7501
7682
 
7502
- # The type used for enabling SMS MFA at the user level.
7683
+ # The type used for enabling SMS MFA at the user level. Phone numbers
7684
+ # don't need to be verified to be used for SMS MFA. If an MFA type is
7685
+ # enabled for a user, the user will be prompted for MFA during all sign
7686
+ # in attempts, unless device tracking is turned on and the device has
7687
+ # been trusted. If you would like MFA to be applied selectively based on
7688
+ # the assessed risk level of sign in attempts, disable MFA for users and
7689
+ # turn on Adaptive Authentication for the user pool.
7503
7690
  #
7504
7691
  # @note When making an API call, you may pass SMSMfaSettingsType
7505
7692
  # data as a hash:
@@ -7510,7 +7697,10 @@ module Aws::CognitoIdentityProvider
7510
7697
  # }
7511
7698
  #
7512
7699
  # @!attribute [rw] enabled
7513
- # Specifies whether SMS text message MFA is enabled.
7700
+ # Specifies whether SMS text message MFA is enabled. If an MFA type is
7701
+ # enabled for a user, the user will be prompted for MFA during all
7702
+ # sign in attempts, unless device tracking is turned on and the device
7703
+ # has been trusted.
7514
7704
  # @return [Boolean]
7515
7705
  #
7516
7706
  # @!attribute [rw] preferred_mfa
@@ -7857,7 +8047,11 @@ module Aws::CognitoIdentityProvider
7857
8047
  # @return [Types::SoftwareTokenMfaConfigType]
7858
8048
  #
7859
8049
  # @!attribute [rw] mfa_configuration
7860
- # The MFA configuration. Valid values include:
8050
+ # The MFA configuration. Users who don't have an MFA factor set up
8051
+ # won't be able to sign-in if you set the MfaConfiguration value to
8052
+ # ‘ON’. See [Adding Multi-Factor Authentication (MFA) to a User
8053
+ # Pool](cognito/latest/developerguide/user-pool-settings-mfa.html) to
8054
+ # learn more. Valid values include:
7861
8055
  #
7862
8056
  # * `OFF` MFA will not be used for any users.
7863
8057
  #
@@ -8119,7 +8313,12 @@ module Aws::CognitoIdentityProvider
8119
8313
  # @!attribute [rw] sns_caller_arn
8120
8314
  # The Amazon Resource Name (ARN) of the Amazon Simple Notification
8121
8315
  # Service (SNS) caller. This is the ARN of the IAM role in your AWS
8122
- # account which Cognito will use to send SMS messages.
8316
+ # account which Cognito will use to send SMS messages. SMS messages
8317
+ # are subject to a [spending limit][1].
8318
+ #
8319
+ #
8320
+ #
8321
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html
8123
8322
  # @return [String]
8124
8323
  #
8125
8324
  # @!attribute [rw] external_id
@@ -8132,6 +8331,14 @@ module Aws::CognitoIdentityProvider
8132
8331
  # role for SMS MFA, Cognito will create a role with the required
8133
8332
  # permissions and a trust policy that demonstrates use of the
8134
8333
  # `ExternalId`.
8334
+ #
8335
+ # For more information about the `ExternalId` of a role, see [How to
8336
+ # use an external ID when granting access to your AWS resources to a
8337
+ # third party][1]
8338
+ #
8339
+ #
8340
+ #
8341
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
8135
8342
  # @return [String]
8136
8343
  #
8137
8344
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SmsConfigurationType AWS API Documentation
@@ -8212,7 +8419,13 @@ module Aws::CognitoIdentityProvider
8212
8419
  include Aws::Structure
8213
8420
  end
8214
8421
 
8215
- # The type used for enabling software token MFA at the user level.
8422
+ # The type used for enabling software token MFA at the user level. If an
8423
+ # MFA type is enabled for a user, the user will be prompted for MFA
8424
+ # during all sign in attempts, unless device tracking is turned on and
8425
+ # the device has been trusted. If you would like MFA to be applied
8426
+ # selectively based on the assessed risk level of sign in attempts,
8427
+ # disable MFA for users and turn on Adaptive Authentication for the user
8428
+ # pool.
8216
8429
  #
8217
8430
  # @note When making an API call, you may pass SoftwareTokenMfaSettingsType
8218
8431
  # data as a hash:
@@ -8223,7 +8436,10 @@ module Aws::CognitoIdentityProvider
8223
8436
  # }
8224
8437
  #
8225
8438
  # @!attribute [rw] enabled
8226
- # Specifies whether software token MFA is enabled.
8439
+ # Specifies whether software token MFA is enabled. If an MFA type is
8440
+ # enabled for a user, the user will be prompted for MFA during all
8441
+ # sign in attempts, unless device tracking is turned on and the device
8442
+ # has been trusted.
8227
8443
  # @return [Boolean]
8228
8444
  #
8229
8445
  # @!attribute [rw] preferred_mfa
@@ -9281,6 +9497,15 @@ module Aws::CognitoIdentityProvider
9281
9497
  # verify_auth_challenge_response: "ArnType",
9282
9498
  # pre_token_generation: "ArnType",
9283
9499
  # user_migration: "ArnType",
9500
+ # custom_sms_sender: {
9501
+ # lambda_version: "V1_0", # required, accepts V1_0
9502
+ # lambda_arn: "ArnType", # required
9503
+ # },
9504
+ # custom_email_sender: {
9505
+ # lambda_version: "V1_0", # required, accepts V1_0
9506
+ # lambda_arn: "ArnType", # required
9507
+ # },
9508
+ # kms_key_id: "ArnType",
9284
9509
  # },
9285
9510
  # auto_verified_attributes: ["phone_number"], # accepts phone_number, email
9286
9511
  # sms_verification_message: "SmsVerificationMessageType",
@@ -9381,10 +9606,16 @@ module Aws::CognitoIdentityProvider
9381
9606
  # user registration.
9382
9607
  #
9383
9608
  # * `ON` - MFA tokens are required for all user registrations. You can
9384
- # only specify required when you are initially creating a user pool.
9609
+ # only specify ON when you are initially creating a user pool. You
9610
+ # can use the [SetUserPoolMfaConfig][1] API operation to turn MFA
9611
+ # "ON" for existing user pools.
9385
9612
  #
9386
9613
  # * `OPTIONAL` - Users have the option when registering to create an
9387
9614
  # MFA token.
9615
+ #
9616
+ #
9617
+ #
9618
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
9388
9619
  # @return [String]
9389
9620
  #
9390
9621
  # @!attribute [rw] device_configuration
@@ -10115,6 +10346,24 @@ module Aws::CognitoIdentityProvider
10115
10346
  # @!attribute [rw] sms_configuration_failure
10116
10347
  # The reason why the SMS configuration cannot send the messages to
10117
10348
  # your users.
10349
+ #
10350
+ # This message might include comma-separated values to describe why
10351
+ # your SMS configuration can't send messages to user pool end users.
10352
+ #
10353
+ # * InvalidSmsRoleAccessPolicyException - The IAM role which Cognito
10354
+ # uses to send SMS messages is not properly configured. For more
10355
+ # information, see [SmsConfigurationType][1].
10356
+ #
10357
+ # * SNSSandbox - The AWS account is in SNS Sandbox and messages won’t
10358
+ # reach unverified end users. This parameter won’t get populated
10359
+ # with SNSSandbox if the IAM user creating the user pool doesn’t
10360
+ # have SNS permissions. To learn how to move your AWS account out of
10361
+ # the sandbox, see [Moving out of the SMS sandbox][2].
10362
+ #
10363
+ #
10364
+ #
10365
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html
10366
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html
10118
10367
  # @return [String]
10119
10368
  #
10120
10369
  # @!attribute [rw] email_configuration_failure
@@ -10347,21 +10596,41 @@ module Aws::CognitoIdentityProvider
10347
10596
  # @return [String]
10348
10597
  #
10349
10598
  # @!attribute [rw] email_message
10350
- # The email message template.
10599
+ # The email message template. EmailMessage is allowed only if [
10600
+ # EmailSendingAccount][1] is DEVELOPER.
10601
+ #
10602
+ #
10603
+ #
10604
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10351
10605
  # @return [String]
10352
10606
  #
10353
10607
  # @!attribute [rw] email_subject
10354
- # The subject line for the email message template.
10608
+ # The subject line for the email message template. EmailSubject is
10609
+ # allowed only if [EmailSendingAccount][1] is DEVELOPER.
10610
+ #
10611
+ #
10612
+ #
10613
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10355
10614
  # @return [String]
10356
10615
  #
10357
10616
  # @!attribute [rw] email_message_by_link
10358
10617
  # The email message template for sending a confirmation link to the
10359
- # user.
10618
+ # user. EmailMessageByLink is allowed only if [
10619
+ # EmailSendingAccount][1] is DEVELOPER.
10620
+ #
10621
+ #
10622
+ #
10623
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10360
10624
  # @return [String]
10361
10625
  #
10362
10626
  # @!attribute [rw] email_subject_by_link
10363
10627
  # The subject line for the email message template for sending a
10364
- # confirmation link to the user.
10628
+ # confirmation link to the user. EmailSubjectByLink is allowed only [
10629
+ # EmailSendingAccount][1] is DEVELOPER.
10630
+ #
10631
+ #
10632
+ #
10633
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
10365
10634
  # @return [String]
10366
10635
  #
10367
10636
  # @!attribute [rw] default_email_option