aws-sdk-cognitoidentityprovider 1.44.0 → 1.49.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a0ba68f2a2ee6fa437c9ccdbeaa727e7ffe2c4586dd7e43a6415d3db4c902ab5
|
4
|
+
data.tar.gz: f83d6c040cdcc531fa400ef6f8b38698d50c98d3c3582ea30d9dd2c6d9442f06
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 43afd3a06079cb3b2580dd2157ed931c82902d4013107bfc65217357e25572f23eec85eb65a2ae7c81385298ea8640b697f74f327ec37b30853feee5d6ab2cf5
|
7
|
+
data.tar.gz: 76841e53dc05fdb7ea6b9d62f7d83403c3033da47d74a350a2cdcb17dada5f76d212d8dc4f4c03b6a276b34c6bbfa36022de834ee3b8ff78089b7743ab948b0a
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-cognitoidentityprovider/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::CognitoIdentityProvider
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.49.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::CognitoIdentityProvider
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::CognitoIdentityProvider
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -2731,9 +2746,21 @@ module Aws::CognitoIdentityProvider
|
|
2731
2746
|
#
|
2732
2747
|
# @option params [String] :email_verification_message
|
2733
2748
|
# A string representing the email verification message.
|
2749
|
+
# EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
|
2750
|
+
# is DEVELOPER.
|
2751
|
+
#
|
2752
|
+
#
|
2753
|
+
#
|
2754
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
2734
2755
|
#
|
2735
2756
|
# @option params [String] :email_verification_subject
|
2736
2757
|
# A string representing the email verification subject.
|
2758
|
+
# EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
|
2759
|
+
# is DEVELOPER.
|
2760
|
+
#
|
2761
|
+
#
|
2762
|
+
#
|
2763
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
2737
2764
|
#
|
2738
2765
|
# @option params [Types::VerificationMessageTemplateType] :verification_message_template
|
2739
2766
|
# The template for the verification message that the user sees when the
|
@@ -2819,6 +2846,15 @@ module Aws::CognitoIdentityProvider
|
|
2819
2846
|
# verify_auth_challenge_response: "ArnType",
|
2820
2847
|
# pre_token_generation: "ArnType",
|
2821
2848
|
# user_migration: "ArnType",
|
2849
|
+
# custom_sms_sender: {
|
2850
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
2851
|
+
# lambda_arn: "ArnType", # required
|
2852
|
+
# },
|
2853
|
+
# custom_email_sender: {
|
2854
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
2855
|
+
# lambda_arn: "ArnType", # required
|
2856
|
+
# },
|
2857
|
+
# kms_key_id: "ArnType",
|
2822
2858
|
# },
|
2823
2859
|
# auto_verified_attributes: ["phone_number"], # accepts phone_number, email
|
2824
2860
|
# alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
|
@@ -2916,6 +2952,11 @@ module Aws::CognitoIdentityProvider
|
|
2916
2952
|
# resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
|
2917
2953
|
# resp.user_pool.lambda_config.pre_token_generation #=> String
|
2918
2954
|
# resp.user_pool.lambda_config.user_migration #=> String
|
2955
|
+
# resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
|
2956
|
+
# resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
|
2957
|
+
# resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
|
2958
|
+
# resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
|
2959
|
+
# resp.user_pool.lambda_config.kms_key_id #=> String
|
2919
2960
|
# resp.user_pool.status #=> String, one of "Enabled", "Disabled"
|
2920
2961
|
# resp.user_pool.last_modified_date #=> Time
|
2921
2962
|
# resp.user_pool.creation_date #=> Time
|
@@ -3731,6 +3772,11 @@ module Aws::CognitoIdentityProvider
|
|
3731
3772
|
# resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
|
3732
3773
|
# resp.user_pool.lambda_config.pre_token_generation #=> String
|
3733
3774
|
# resp.user_pool.lambda_config.user_migration #=> String
|
3775
|
+
# resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
|
3776
|
+
# resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
|
3777
|
+
# resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
|
3778
|
+
# resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
|
3779
|
+
# resp.user_pool.lambda_config.kms_key_id #=> String
|
3734
3780
|
# resp.user_pool.status #=> String, one of "Enabled", "Disabled"
|
3735
3781
|
# resp.user_pool.last_modified_date #=> Time
|
3736
3782
|
# resp.user_pool.creation_date #=> Time
|
@@ -4982,6 +5028,11 @@ module Aws::CognitoIdentityProvider
|
|
4982
5028
|
# resp.user_pools[0].lambda_config.verify_auth_challenge_response #=> String
|
4983
5029
|
# resp.user_pools[0].lambda_config.pre_token_generation #=> String
|
4984
5030
|
# resp.user_pools[0].lambda_config.user_migration #=> String
|
5031
|
+
# resp.user_pools[0].lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
|
5032
|
+
# resp.user_pools[0].lambda_config.custom_sms_sender.lambda_arn #=> String
|
5033
|
+
# resp.user_pools[0].lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
|
5034
|
+
# resp.user_pools[0].lambda_config.custom_email_sender.lambda_arn #=> String
|
5035
|
+
# resp.user_pools[0].lambda_config.kms_key_id #=> String
|
4985
5036
|
# resp.user_pools[0].status #=> String, one of "Enabled", "Disabled"
|
4986
5037
|
# resp.user_pools[0].last_modified_date #=> Time
|
4987
5038
|
# resp.user_pools[0].creation_date #=> Time
|
@@ -5604,7 +5655,12 @@ module Aws::CognitoIdentityProvider
|
|
5604
5655
|
# one factor can be set as preferred. The preferred MFA factor will be
|
5605
5656
|
# used to authenticate a user if multiple factors are enabled. If
|
5606
5657
|
# multiple options are enabled and no preference is set, a challenge to
|
5607
|
-
# choose an MFA option will be returned during sign in.
|
5658
|
+
# choose an MFA option will be returned during sign in. If an MFA type
|
5659
|
+
# is enabled for a user, the user will be prompted for MFA during all
|
5660
|
+
# sign in attempts, unless device tracking is turned on and the device
|
5661
|
+
# has been trusted. If you would like MFA to be applied selectively
|
5662
|
+
# based on the assessed risk level of sign in attempts, disable MFA for
|
5663
|
+
# users and turn on Adaptive Authentication for the user pool.
|
5608
5664
|
#
|
5609
5665
|
# @option params [Types::SMSMfaSettingsType] :sms_mfa_settings
|
5610
5666
|
# The SMS text message multi-factor authentication (MFA) settings.
|
@@ -6467,6 +6523,15 @@ module Aws::CognitoIdentityProvider
|
|
6467
6523
|
# verify_auth_challenge_response: "ArnType",
|
6468
6524
|
# pre_token_generation: "ArnType",
|
6469
6525
|
# user_migration: "ArnType",
|
6526
|
+
# custom_sms_sender: {
|
6527
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
6528
|
+
# lambda_arn: "ArnType", # required
|
6529
|
+
# },
|
6530
|
+
# custom_email_sender: {
|
6531
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
6532
|
+
# lambda_arn: "ArnType", # required
|
6533
|
+
# },
|
6534
|
+
# kms_key_id: "ArnType",
|
6470
6535
|
# },
|
6471
6536
|
# auto_verified_attributes: ["phone_number"], # accepts phone_number, email
|
6472
6537
|
# sms_verification_message: "SmsVerificationMessageType",
|
@@ -6967,7 +7032,7 @@ module Aws::CognitoIdentityProvider
|
|
6967
7032
|
params: params,
|
6968
7033
|
config: config)
|
6969
7034
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
6970
|
-
context[:gem_version] = '1.
|
7035
|
+
context[:gem_version] = '1.49.0'
|
6971
7036
|
Seahorse::Client::Request.new(handlers, context)
|
6972
7037
|
end
|
6973
7038
|
|
@@ -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"))
|
@@ -3628,6 +3628,15 @@ module Aws::CognitoIdentityProvider
|
|
3628
3628
|
# verify_auth_challenge_response: "ArnType",
|
3629
3629
|
# pre_token_generation: "ArnType",
|
3630
3630
|
# user_migration: "ArnType",
|
3631
|
+
# custom_sms_sender: {
|
3632
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
3633
|
+
# lambda_arn: "ArnType", # required
|
3634
|
+
# },
|
3635
|
+
# custom_email_sender: {
|
3636
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
3637
|
+
# lambda_arn: "ArnType", # required
|
3638
|
+
# },
|
3639
|
+
# kms_key_id: "ArnType",
|
3631
3640
|
# },
|
3632
3641
|
# auto_verified_attributes: ["phone_number"], # accepts phone_number, email
|
3633
3642
|
# alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
|
@@ -3757,10 +3766,22 @@ module Aws::CognitoIdentityProvider
|
|
3757
3766
|
#
|
3758
3767
|
# @!attribute [rw] email_verification_message
|
3759
3768
|
# A string representing the email verification message.
|
3769
|
+
# EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
|
3770
|
+
# is DEVELOPER.
|
3771
|
+
#
|
3772
|
+
#
|
3773
|
+
#
|
3774
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
3760
3775
|
# @return [String]
|
3761
3776
|
#
|
3762
3777
|
# @!attribute [rw] email_verification_subject
|
3763
3778
|
# A string representing the email verification subject.
|
3779
|
+
# EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
|
3780
|
+
# is DEVELOPER.
|
3781
|
+
#
|
3782
|
+
#
|
3783
|
+
#
|
3784
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
3764
3785
|
# @return [String]
|
3765
3786
|
#
|
3766
3787
|
# @!attribute [rw] verification_message_template
|
@@ -3898,6 +3919,66 @@ module Aws::CognitoIdentityProvider
|
|
3898
3919
|
include Aws::Structure
|
3899
3920
|
end
|
3900
3921
|
|
3922
|
+
# A custom email sender Lambda configuration type.
|
3923
|
+
#
|
3924
|
+
# @note When making an API call, you may pass CustomEmailLambdaVersionConfigType
|
3925
|
+
# data as a hash:
|
3926
|
+
#
|
3927
|
+
# {
|
3928
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
3929
|
+
# lambda_arn: "ArnType", # required
|
3930
|
+
# }
|
3931
|
+
#
|
3932
|
+
# @!attribute [rw] lambda_version
|
3933
|
+
# The Lambda version represents the signature of the "request"
|
3934
|
+
# attribute in the "event" information Amazon Cognito passes to your
|
3935
|
+
# custom email Lambda function. The only supported value is `V1_0`.
|
3936
|
+
# @return [String]
|
3937
|
+
#
|
3938
|
+
# @!attribute [rw] lambda_arn
|
3939
|
+
# The Lambda Amazon Resource Name of the Lambda function that Amazon
|
3940
|
+
# Cognito triggers to send email notifications to users.
|
3941
|
+
# @return [String]
|
3942
|
+
#
|
3943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CustomEmailLambdaVersionConfigType AWS API Documentation
|
3944
|
+
#
|
3945
|
+
class CustomEmailLambdaVersionConfigType < Struct.new(
|
3946
|
+
:lambda_version,
|
3947
|
+
:lambda_arn)
|
3948
|
+
SENSITIVE = []
|
3949
|
+
include Aws::Structure
|
3950
|
+
end
|
3951
|
+
|
3952
|
+
# A custom SMS sender Lambda configuration type.
|
3953
|
+
#
|
3954
|
+
# @note When making an API call, you may pass CustomSMSLambdaVersionConfigType
|
3955
|
+
# data as a hash:
|
3956
|
+
#
|
3957
|
+
# {
|
3958
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
3959
|
+
# lambda_arn: "ArnType", # required
|
3960
|
+
# }
|
3961
|
+
#
|
3962
|
+
# @!attribute [rw] lambda_version
|
3963
|
+
# The Lambda version represents the signature of the "request"
|
3964
|
+
# attribute in the "event" information Amazon Cognito passes to your
|
3965
|
+
# custom SMS Lambda function. The only supported value is `V1_0`.
|
3966
|
+
# @return [String]
|
3967
|
+
#
|
3968
|
+
# @!attribute [rw] lambda_arn
|
3969
|
+
# The Lambda Amazon Resource Name of the Lambda function that Amazon
|
3970
|
+
# Cognito triggers to send SMS notifications to users.
|
3971
|
+
# @return [String]
|
3972
|
+
#
|
3973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CustomSMSLambdaVersionConfigType AWS API Documentation
|
3974
|
+
#
|
3975
|
+
class CustomSMSLambdaVersionConfigType < Struct.new(
|
3976
|
+
:lambda_version,
|
3977
|
+
:lambda_arn)
|
3978
|
+
SENSITIVE = []
|
3979
|
+
include Aws::Structure
|
3980
|
+
end
|
3981
|
+
|
3901
3982
|
# @note When making an API call, you may pass DeleteGroupRequest
|
3902
3983
|
# data as a hash:
|
3903
3984
|
#
|
@@ -4528,6 +4609,16 @@ module Aws::CognitoIdentityProvider
|
|
4528
4609
|
|
4529
4610
|
# The email configuration type.
|
4530
4611
|
#
|
4612
|
+
# <note markdown="1"> Amazon Cognito has specific regions for use with Amazon SES. For more
|
4613
|
+
# information on the supported regions, see [Email Settings for Amazon
|
4614
|
+
# Cognito User Pools][1].
|
4615
|
+
#
|
4616
|
+
# </note>
|
4617
|
+
#
|
4618
|
+
#
|
4619
|
+
#
|
4620
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html
|
4621
|
+
#
|
4531
4622
|
# @note When making an API call, you may pass EmailConfigurationType
|
4532
4623
|
# data as a hash:
|
4533
4624
|
#
|
@@ -4580,6 +4671,29 @@ module Aws::CognitoIdentityProvider
|
|
4580
4671
|
# customize the FROM address, provide the ARN of an Amazon SES
|
4581
4672
|
# verified email address for the `SourceArn` parameter.
|
4582
4673
|
#
|
4674
|
+
# If EmailSendingAccount is COGNITO\_DEFAULT, the following
|
4675
|
+
# parameters aren't allowed:
|
4676
|
+
#
|
4677
|
+
# * EmailVerificationMessage
|
4678
|
+
#
|
4679
|
+
# * EmailVerificationSubject
|
4680
|
+
#
|
4681
|
+
# * InviteMessageTemplate.EmailMessage
|
4682
|
+
#
|
4683
|
+
# * InviteMessageTemplate.EmailSubject
|
4684
|
+
#
|
4685
|
+
# * VerificationMessageTemplate.EmailMessage
|
4686
|
+
#
|
4687
|
+
# * VerificationMessageTemplate.EmailMessageByLink
|
4688
|
+
#
|
4689
|
+
# * VerificationMessageTemplate.EmailSubject,
|
4690
|
+
#
|
4691
|
+
# * VerificationMessageTemplate.EmailSubjectByLink
|
4692
|
+
#
|
4693
|
+
# <note markdown="1"> DEVELOPER EmailSendingAccount is required.
|
4694
|
+
#
|
4695
|
+
# </note>
|
4696
|
+
#
|
4583
4697
|
# DEVELOPER
|
4584
4698
|
#
|
4585
4699
|
# : When Amazon Cognito emails your users, it uses your Amazon SES
|
@@ -5975,6 +6089,15 @@ module Aws::CognitoIdentityProvider
|
|
5975
6089
|
# verify_auth_challenge_response: "ArnType",
|
5976
6090
|
# pre_token_generation: "ArnType",
|
5977
6091
|
# user_migration: "ArnType",
|
6092
|
+
# custom_sms_sender: {
|
6093
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
6094
|
+
# lambda_arn: "ArnType", # required
|
6095
|
+
# },
|
6096
|
+
# custom_email_sender: {
|
6097
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
6098
|
+
# lambda_arn: "ArnType", # required
|
6099
|
+
# },
|
6100
|
+
# kms_key_id: "ArnType",
|
5978
6101
|
# }
|
5979
6102
|
#
|
5980
6103
|
# @!attribute [rw] pre_sign_up
|
@@ -6017,6 +6140,21 @@ module Aws::CognitoIdentityProvider
|
|
6017
6140
|
# The user migration Lambda config type.
|
6018
6141
|
# @return [String]
|
6019
6142
|
#
|
6143
|
+
# @!attribute [rw] custom_sms_sender
|
6144
|
+
# A custom SMS sender AWS Lambda trigger.
|
6145
|
+
# @return [Types::CustomSMSLambdaVersionConfigType]
|
6146
|
+
#
|
6147
|
+
# @!attribute [rw] custom_email_sender
|
6148
|
+
# A custom email sender AWS Lambda trigger.
|
6149
|
+
# @return [Types::CustomEmailLambdaVersionConfigType]
|
6150
|
+
#
|
6151
|
+
# @!attribute [rw] kms_key_id
|
6152
|
+
# The Amazon Resource Name of Key Management Service [Customer master
|
6153
|
+
# keys](/kms/latest/developerguide/concepts.html#master_keys) . Amazon
|
6154
|
+
# Cognito uses the key to encrypt codes and temporary passwords sent
|
6155
|
+
# to `CustomEmailSender` and `CustomSMSSender`.
|
6156
|
+
# @return [String]
|
6157
|
+
#
|
6020
6158
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/LambdaConfigType AWS API Documentation
|
6021
6159
|
#
|
6022
6160
|
class LambdaConfigType < Struct.new(
|
@@ -6029,7 +6167,10 @@ module Aws::CognitoIdentityProvider
|
|
6029
6167
|
:create_auth_challenge,
|
6030
6168
|
:verify_auth_challenge_response,
|
6031
6169
|
:pre_token_generation,
|
6032
|
-
:user_migration
|
6170
|
+
:user_migration,
|
6171
|
+
:custom_sms_sender,
|
6172
|
+
:custom_email_sender,
|
6173
|
+
:kms_key_id)
|
6033
6174
|
SENSITIVE = []
|
6034
6175
|
include Aws::Structure
|
6035
6176
|
end
|
@@ -6690,11 +6831,21 @@ module Aws::CognitoIdentityProvider
|
|
6690
6831
|
# @return [String]
|
6691
6832
|
#
|
6692
6833
|
# @!attribute [rw] email_message
|
6693
|
-
# The message template for email messages.
|
6834
|
+
# The message template for email messages. EmailMessage is allowed
|
6835
|
+
# only if [EmailSendingAccount][1] is DEVELOPER.
|
6836
|
+
#
|
6837
|
+
#
|
6838
|
+
#
|
6839
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
6694
6840
|
# @return [String]
|
6695
6841
|
#
|
6696
6842
|
# @!attribute [rw] email_subject
|
6697
|
-
# The subject line for email messages.
|
6843
|
+
# The subject line for email messages. EmailSubject is allowed only if
|
6844
|
+
# [EmailSendingAccount][1] is DEVELOPER.
|
6845
|
+
#
|
6846
|
+
#
|
6847
|
+
#
|
6848
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
6698
6849
|
# @return [String]
|
6699
6850
|
#
|
6700
6851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MessageTemplateType AWS API Documentation
|
@@ -7499,7 +7650,13 @@ module Aws::CognitoIdentityProvider
|
|
7499
7650
|
include Aws::Structure
|
7500
7651
|
end
|
7501
7652
|
|
7502
|
-
# The type used for enabling SMS MFA at the user level.
|
7653
|
+
# The type used for enabling SMS MFA at the user level. Phone numbers
|
7654
|
+
# don't need to be verified to be used for SMS MFA. If an MFA type is
|
7655
|
+
# enabled for a user, the user will be prompted for MFA during all sign
|
7656
|
+
# in attempts, unless device tracking is turned on and the device has
|
7657
|
+
# been trusted. If you would like MFA to be applied selectively based on
|
7658
|
+
# the assessed risk level of sign in attempts, disable MFA for users and
|
7659
|
+
# turn on Adaptive Authentication for the user pool.
|
7503
7660
|
#
|
7504
7661
|
# @note When making an API call, you may pass SMSMfaSettingsType
|
7505
7662
|
# data as a hash:
|
@@ -7510,7 +7667,10 @@ module Aws::CognitoIdentityProvider
|
|
7510
7667
|
# }
|
7511
7668
|
#
|
7512
7669
|
# @!attribute [rw] enabled
|
7513
|
-
# Specifies whether SMS text message MFA is enabled.
|
7670
|
+
# Specifies whether SMS text message MFA is enabled. If an MFA type is
|
7671
|
+
# enabled for a user, the user will be prompted for MFA during all
|
7672
|
+
# sign in attempts, unless device tracking is turned on and the device
|
7673
|
+
# has been trusted.
|
7514
7674
|
# @return [Boolean]
|
7515
7675
|
#
|
7516
7676
|
# @!attribute [rw] preferred_mfa
|
@@ -8119,7 +8279,12 @@ module Aws::CognitoIdentityProvider
|
|
8119
8279
|
# @!attribute [rw] sns_caller_arn
|
8120
8280
|
# The Amazon Resource Name (ARN) of the Amazon Simple Notification
|
8121
8281
|
# Service (SNS) caller. This is the ARN of the IAM role in your AWS
|
8122
|
-
# account which Cognito will use to send SMS messages.
|
8282
|
+
# account which Cognito will use to send SMS messages. SMS messages
|
8283
|
+
# are subject to a [spending limit][1].
|
8284
|
+
#
|
8285
|
+
#
|
8286
|
+
#
|
8287
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html
|
8123
8288
|
# @return [String]
|
8124
8289
|
#
|
8125
8290
|
# @!attribute [rw] external_id
|
@@ -8212,7 +8377,13 @@ module Aws::CognitoIdentityProvider
|
|
8212
8377
|
include Aws::Structure
|
8213
8378
|
end
|
8214
8379
|
|
8215
|
-
# The type used for enabling software token MFA at the user level.
|
8380
|
+
# The type used for enabling software token MFA at the user level. If an
|
8381
|
+
# MFA type is enabled for a user, the user will be prompted for MFA
|
8382
|
+
# during all sign in attempts, unless device tracking is turned on and
|
8383
|
+
# the device has been trusted. If you would like MFA to be applied
|
8384
|
+
# selectively based on the assessed risk level of sign in attempts,
|
8385
|
+
# disable MFA for users and turn on Adaptive Authentication for the user
|
8386
|
+
# pool.
|
8216
8387
|
#
|
8217
8388
|
# @note When making an API call, you may pass SoftwareTokenMfaSettingsType
|
8218
8389
|
# data as a hash:
|
@@ -8223,7 +8394,10 @@ module Aws::CognitoIdentityProvider
|
|
8223
8394
|
# }
|
8224
8395
|
#
|
8225
8396
|
# @!attribute [rw] enabled
|
8226
|
-
# Specifies whether software token MFA is enabled.
|
8397
|
+
# Specifies whether software token MFA is enabled. If an MFA type is
|
8398
|
+
# enabled for a user, the user will be prompted for MFA during all
|
8399
|
+
# sign in attempts, unless device tracking is turned on and the device
|
8400
|
+
# has been trusted.
|
8227
8401
|
# @return [Boolean]
|
8228
8402
|
#
|
8229
8403
|
# @!attribute [rw] preferred_mfa
|
@@ -9281,6 +9455,15 @@ module Aws::CognitoIdentityProvider
|
|
9281
9455
|
# verify_auth_challenge_response: "ArnType",
|
9282
9456
|
# pre_token_generation: "ArnType",
|
9283
9457
|
# user_migration: "ArnType",
|
9458
|
+
# custom_sms_sender: {
|
9459
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
9460
|
+
# lambda_arn: "ArnType", # required
|
9461
|
+
# },
|
9462
|
+
# custom_email_sender: {
|
9463
|
+
# lambda_version: "V1_0", # required, accepts V1_0
|
9464
|
+
# lambda_arn: "ArnType", # required
|
9465
|
+
# },
|
9466
|
+
# kms_key_id: "ArnType",
|
9284
9467
|
# },
|
9285
9468
|
# auto_verified_attributes: ["phone_number"], # accepts phone_number, email
|
9286
9469
|
# sms_verification_message: "SmsVerificationMessageType",
|
@@ -10347,21 +10530,41 @@ module Aws::CognitoIdentityProvider
|
|
10347
10530
|
# @return [String]
|
10348
10531
|
#
|
10349
10532
|
# @!attribute [rw] email_message
|
10350
|
-
# The email message template.
|
10533
|
+
# The email message template. EmailMessage is allowed only if [
|
10534
|
+
# EmailSendingAccount][1] is DEVELOPER.
|
10535
|
+
#
|
10536
|
+
#
|
10537
|
+
#
|
10538
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
10351
10539
|
# @return [String]
|
10352
10540
|
#
|
10353
10541
|
# @!attribute [rw] email_subject
|
10354
|
-
# The subject line for the email message template.
|
10542
|
+
# The subject line for the email message template. EmailSubject is
|
10543
|
+
# allowed only if [EmailSendingAccount][1] is DEVELOPER.
|
10544
|
+
#
|
10545
|
+
#
|
10546
|
+
#
|
10547
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
10355
10548
|
# @return [String]
|
10356
10549
|
#
|
10357
10550
|
# @!attribute [rw] email_message_by_link
|
10358
10551
|
# The email message template for sending a confirmation link to the
|
10359
|
-
# user.
|
10552
|
+
# user. EmailMessageByLink is allowed only if [
|
10553
|
+
# EmailSendingAccount][1] is DEVELOPER.
|
10554
|
+
#
|
10555
|
+
#
|
10556
|
+
#
|
10557
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
10360
10558
|
# @return [String]
|
10361
10559
|
#
|
10362
10560
|
# @!attribute [rw] email_subject_by_link
|
10363
10561
|
# The subject line for the email message template for sending a
|
10364
|
-
# confirmation link to the user.
|
10562
|
+
# confirmation link to the user. EmailSubjectByLink is allowed only [
|
10563
|
+
# EmailSendingAccount][1] is DEVELOPER.
|
10564
|
+
#
|
10565
|
+
#
|
10566
|
+
#
|
10567
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
|
10365
10568
|
# @return [String]
|
10366
10569
|
#
|
10367
10570
|
# @!attribute [rw] default_email_option
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cognitoidentityprovider
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.49.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-02-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.112.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|