aws-sdk-cognitoidentityprovider 1.109.0 → 1.111.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +1131 -158
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +398 -5
- data/lib/aws-sdk-cognitoidentityprovider/errors.rb +165 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +2729 -473
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +178 -19
- data/sig/errors.rbs +31 -0
- data/sig/types.rbs +240 -16
- metadata +2 -2
data/sig/client.rbs
CHANGED
@@ -242,7 +242,7 @@ module Aws
|
|
242
242
|
|
243
243
|
interface _AdminInitiateAuthResponseSuccess
|
244
244
|
include ::Seahorse::Client::_ResponseSuccess[Types::AdminInitiateAuthResponse]
|
245
|
-
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
245
|
+
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")
|
246
246
|
def session: () -> ::String
|
247
247
|
def challenge_parameters: () -> ::Hash[::String, ::String]
|
248
248
|
def authentication_result: () -> Types::AuthenticationResultType
|
@@ -251,7 +251,7 @@ module Aws
|
|
251
251
|
def admin_initiate_auth: (
|
252
252
|
user_pool_id: ::String,
|
253
253
|
client_id: ::String,
|
254
|
-
auth_flow: ("USER_SRP_AUTH" | "REFRESH_TOKEN_AUTH" | "REFRESH_TOKEN" | "CUSTOM_AUTH" | "ADMIN_NO_SRP_AUTH" | "USER_PASSWORD_AUTH" | "ADMIN_USER_PASSWORD_AUTH"),
|
254
|
+
auth_flow: ("USER_SRP_AUTH" | "REFRESH_TOKEN_AUTH" | "REFRESH_TOKEN" | "CUSTOM_AUTH" | "ADMIN_NO_SRP_AUTH" | "USER_PASSWORD_AUTH" | "ADMIN_USER_PASSWORD_AUTH" | "USER_AUTH"),
|
255
255
|
?auth_parameters: Hash[::String, ::String],
|
256
256
|
?client_metadata: Hash[::String, ::String],
|
257
257
|
?analytics_metadata: {
|
@@ -268,7 +268,8 @@ module Aws
|
|
268
268
|
},
|
269
269
|
],
|
270
270
|
encoded_data: ::String?
|
271
|
-
}
|
271
|
+
},
|
272
|
+
?session: ::String
|
272
273
|
) -> _AdminInitiateAuthResponseSuccess
|
273
274
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminInitiateAuthResponseSuccess
|
274
275
|
|
@@ -354,7 +355,7 @@ module Aws
|
|
354
355
|
|
355
356
|
interface _AdminRespondToAuthChallengeResponseSuccess
|
356
357
|
include ::Seahorse::Client::_ResponseSuccess[Types::AdminRespondToAuthChallengeResponse]
|
357
|
-
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
358
|
+
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")
|
358
359
|
def session: () -> ::String
|
359
360
|
def challenge_parameters: () -> ::Hash[::String, ::String]
|
360
361
|
def authentication_result: () -> Types::AuthenticationResultType
|
@@ -363,7 +364,7 @@ module Aws
|
|
363
364
|
def admin_respond_to_auth_challenge: (
|
364
365
|
user_pool_id: ::String,
|
365
366
|
client_id: ::String,
|
366
|
-
challenge_name: ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED"),
|
367
|
+
challenge_name: ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP"),
|
367
368
|
?challenge_responses: Hash[::String, ::String],
|
368
369
|
?session: ::String,
|
369
370
|
?analytics_metadata: {
|
@@ -503,12 +504,23 @@ module Aws
|
|
503
504
|
end
|
504
505
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#change_password-instance_method
|
505
506
|
def change_password: (
|
506
|
-
previous_password: ::String,
|
507
|
+
?previous_password: ::String,
|
507
508
|
proposed_password: ::String,
|
508
509
|
access_token: ::String
|
509
510
|
) -> _ChangePasswordResponseSuccess
|
510
511
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ChangePasswordResponseSuccess
|
511
512
|
|
513
|
+
interface _CompleteWebAuthnRegistrationResponseSuccess
|
514
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CompleteWebAuthnRegistrationResponse]
|
515
|
+
end
|
516
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#complete_web_authn_registration-instance_method
|
517
|
+
def complete_web_authn_registration: (
|
518
|
+
access_token: ::String,
|
519
|
+
credential: {
|
520
|
+
}
|
521
|
+
) -> _CompleteWebAuthnRegistrationResponseSuccess
|
522
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CompleteWebAuthnRegistrationResponseSuccess
|
523
|
+
|
512
524
|
interface _ConfirmDeviceResponseSuccess
|
513
525
|
include ::Seahorse::Client::_ResponseSuccess[Types::ConfirmDeviceResponse]
|
514
526
|
def user_confirmation_necessary: () -> bool
|
@@ -548,6 +560,7 @@ module Aws
|
|
548
560
|
|
549
561
|
interface _ConfirmSignUpResponseSuccess
|
550
562
|
include ::Seahorse::Client::_ResponseSuccess[Types::ConfirmSignUpResponse]
|
563
|
+
def session: () -> ::String
|
551
564
|
end
|
552
565
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#confirm_sign_up-instance_method
|
553
566
|
def confirm_sign_up: (
|
@@ -563,7 +576,8 @@ module Aws
|
|
563
576
|
ip_address: ::String?,
|
564
577
|
encoded_data: ::String?
|
565
578
|
},
|
566
|
-
?client_metadata: Hash[::String, ::String]
|
579
|
+
?client_metadata: Hash[::String, ::String],
|
580
|
+
?session: ::String
|
567
581
|
) -> _ConfirmSignUpResponseSuccess
|
568
582
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConfirmSignUpResponseSuccess
|
569
583
|
|
@@ -596,6 +610,29 @@ module Aws
|
|
596
610
|
) -> _CreateIdentityProviderResponseSuccess
|
597
611
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIdentityProviderResponseSuccess
|
598
612
|
|
613
|
+
interface _CreateManagedLoginBrandingResponseSuccess
|
614
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateManagedLoginBrandingResponse]
|
615
|
+
def managed_login_branding: () -> Types::ManagedLoginBrandingType
|
616
|
+
end
|
617
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_managed_login_branding-instance_method
|
618
|
+
def create_managed_login_branding: (
|
619
|
+
user_pool_id: ::String,
|
620
|
+
client_id: ::String,
|
621
|
+
?use_cognito_provided_values: bool,
|
622
|
+
?settings: {
|
623
|
+
},
|
624
|
+
?assets: Array[
|
625
|
+
{
|
626
|
+
category: ("FAVICON_ICO" | "FAVICON_SVG" | "EMAIL_GRAPHIC" | "SMS_GRAPHIC" | "AUTH_APP_GRAPHIC" | "PASSWORD_GRAPHIC" | "PASSKEY_GRAPHIC" | "PAGE_HEADER_LOGO" | "PAGE_HEADER_BACKGROUND" | "PAGE_FOOTER_LOGO" | "PAGE_FOOTER_BACKGROUND" | "PAGE_BACKGROUND" | "FORM_BACKGROUND" | "FORM_LOGO" | "IDP_BUTTON_ICON"),
|
627
|
+
color_mode: ("LIGHT" | "DARK" | "DYNAMIC"),
|
628
|
+
extension: ("ICO" | "JPEG" | "PNG" | "SVG" | "WEBP"),
|
629
|
+
bytes: ::String?,
|
630
|
+
resource_id: ::String?
|
631
|
+
},
|
632
|
+
]
|
633
|
+
) -> _CreateManagedLoginBrandingResponseSuccess
|
634
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateManagedLoginBrandingResponseSuccess
|
635
|
+
|
599
636
|
interface _CreateResourceServerResponseSuccess
|
600
637
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateResourceServerResponse]
|
601
638
|
def resource_server: () -> Types::ResourceServerType
|
@@ -642,6 +679,9 @@ module Aws
|
|
642
679
|
require_symbols: bool?,
|
643
680
|
password_history_size: ::Integer?,
|
644
681
|
temporary_password_validity_days: ::Integer?
|
682
|
+
}?,
|
683
|
+
sign_in_policy: {
|
684
|
+
allowed_first_auth_factors: Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]?
|
645
685
|
}?
|
646
686
|
},
|
647
687
|
?deletion_protection: ("ACTIVE" | "INACTIVE"),
|
@@ -748,7 +788,8 @@ module Aws
|
|
748
788
|
name: ("verified_email" | "verified_phone_number" | "admin_only")
|
749
789
|
},
|
750
790
|
]?
|
751
|
-
}
|
791
|
+
},
|
792
|
+
?user_pool_tier: ("LITE" | "ESSENTIALS" | "PLUS")
|
752
793
|
) -> _CreateUserPoolResponseSuccess
|
753
794
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserPoolResponseSuccess
|
754
795
|
|
@@ -771,7 +812,7 @@ module Aws
|
|
771
812
|
},
|
772
813
|
?read_attributes: Array[::String],
|
773
814
|
?write_attributes: Array[::String],
|
774
|
-
?explicit_auth_flows: Array[("ADMIN_NO_SRP_AUTH" | "CUSTOM_AUTH_FLOW_ONLY" | "USER_PASSWORD_AUTH" | "ALLOW_ADMIN_USER_PASSWORD_AUTH" | "ALLOW_CUSTOM_AUTH" | "ALLOW_USER_PASSWORD_AUTH" | "ALLOW_USER_SRP_AUTH" | "ALLOW_REFRESH_TOKEN_AUTH")],
|
815
|
+
?explicit_auth_flows: Array[("ADMIN_NO_SRP_AUTH" | "CUSTOM_AUTH_FLOW_ONLY" | "USER_PASSWORD_AUTH" | "ALLOW_ADMIN_USER_PASSWORD_AUTH" | "ALLOW_CUSTOM_AUTH" | "ALLOW_USER_PASSWORD_AUTH" | "ALLOW_USER_SRP_AUTH" | "ALLOW_REFRESH_TOKEN_AUTH" | "ALLOW_USER_AUTH")],
|
775
816
|
?supported_identity_providers: Array[::String],
|
776
817
|
?callback_urls: Array[::String],
|
777
818
|
?logout_urls: Array[::String],
|
@@ -795,12 +836,14 @@ module Aws
|
|
795
836
|
|
796
837
|
interface _CreateUserPoolDomainResponseSuccess
|
797
838
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserPoolDomainResponse]
|
839
|
+
def managed_login_version: () -> ::Integer
|
798
840
|
def cloud_front_domain: () -> ::String
|
799
841
|
end
|
800
842
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#create_user_pool_domain-instance_method
|
801
843
|
def create_user_pool_domain: (
|
802
844
|
domain: ::String,
|
803
845
|
user_pool_id: ::String,
|
846
|
+
?managed_login_version: ::Integer,
|
804
847
|
?custom_domain_config: {
|
805
848
|
certificate_arn: ::String
|
806
849
|
}
|
@@ -821,6 +864,13 @@ module Aws
|
|
821
864
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
822
865
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
823
866
|
|
867
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_managed_login_branding-instance_method
|
868
|
+
def delete_managed_login_branding: (
|
869
|
+
managed_login_branding_id: ::String,
|
870
|
+
user_pool_id: ::String
|
871
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
872
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
873
|
+
|
824
874
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_resource_server-instance_method
|
825
875
|
def delete_resource_server: (
|
826
876
|
user_pool_id: ::String,
|
@@ -867,6 +917,16 @@ module Aws
|
|
867
917
|
) -> _DeleteUserPoolDomainResponseSuccess
|
868
918
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteUserPoolDomainResponseSuccess
|
869
919
|
|
920
|
+
interface _DeleteWebAuthnCredentialResponseSuccess
|
921
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteWebAuthnCredentialResponse]
|
922
|
+
end
|
923
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#delete_web_authn_credential-instance_method
|
924
|
+
def delete_web_authn_credential: (
|
925
|
+
access_token: ::String,
|
926
|
+
credential_id: ::String
|
927
|
+
) -> _DeleteWebAuthnCredentialResponseSuccess
|
928
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteWebAuthnCredentialResponseSuccess
|
929
|
+
|
870
930
|
interface _DescribeIdentityProviderResponseSuccess
|
871
931
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeIdentityProviderResponse]
|
872
932
|
def identity_provider: () -> Types::IdentityProviderType
|
@@ -878,6 +938,30 @@ module Aws
|
|
878
938
|
) -> _DescribeIdentityProviderResponseSuccess
|
879
939
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeIdentityProviderResponseSuccess
|
880
940
|
|
941
|
+
interface _DescribeManagedLoginBrandingResponseSuccess
|
942
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeManagedLoginBrandingResponse]
|
943
|
+
def managed_login_branding: () -> Types::ManagedLoginBrandingType
|
944
|
+
end
|
945
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_managed_login_branding-instance_method
|
946
|
+
def describe_managed_login_branding: (
|
947
|
+
user_pool_id: ::String,
|
948
|
+
managed_login_branding_id: ::String,
|
949
|
+
?return_merged_resources: bool
|
950
|
+
) -> _DescribeManagedLoginBrandingResponseSuccess
|
951
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeManagedLoginBrandingResponseSuccess
|
952
|
+
|
953
|
+
interface _DescribeManagedLoginBrandingByClientResponseSuccess
|
954
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeManagedLoginBrandingByClientResponse]
|
955
|
+
def managed_login_branding: () -> Types::ManagedLoginBrandingType
|
956
|
+
end
|
957
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#describe_managed_login_branding_by_client-instance_method
|
958
|
+
def describe_managed_login_branding_by_client: (
|
959
|
+
user_pool_id: ::String,
|
960
|
+
client_id: ::String,
|
961
|
+
?return_merged_resources: bool
|
962
|
+
) -> _DescribeManagedLoginBrandingByClientResponseSuccess
|
963
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeManagedLoginBrandingByClientResponseSuccess
|
964
|
+
|
881
965
|
interface _DescribeResourceServerResponseSuccess
|
882
966
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeResourceServerResponse]
|
883
967
|
def resource_server: () -> Types::ResourceServerType
|
@@ -1070,12 +1154,26 @@ module Aws
|
|
1070
1154
|
) -> _GetUserAttributeVerificationCodeResponseSuccess
|
1071
1155
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserAttributeVerificationCodeResponseSuccess
|
1072
1156
|
|
1157
|
+
interface _GetUserAuthFactorsResponseSuccess
|
1158
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetUserAuthFactorsResponse]
|
1159
|
+
def username: () -> ::String
|
1160
|
+
def preferred_mfa_setting: () -> ::String
|
1161
|
+
def user_mfa_setting_list: () -> ::Array[::String]
|
1162
|
+
def configured_user_auth_factors: () -> ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]
|
1163
|
+
end
|
1164
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_user_auth_factors-instance_method
|
1165
|
+
def get_user_auth_factors: (
|
1166
|
+
access_token: ::String
|
1167
|
+
) -> _GetUserAuthFactorsResponseSuccess
|
1168
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUserAuthFactorsResponseSuccess
|
1169
|
+
|
1073
1170
|
interface _GetUserPoolMfaConfigResponseSuccess
|
1074
1171
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetUserPoolMfaConfigResponse]
|
1075
1172
|
def sms_mfa_configuration: () -> Types::SmsMfaConfigType
|
1076
1173
|
def software_token_mfa_configuration: () -> Types::SoftwareTokenMfaConfigType
|
1077
1174
|
def email_mfa_configuration: () -> Types::EmailMfaConfigType
|
1078
1175
|
def mfa_configuration: () -> ("OFF" | "ON" | "OPTIONAL")
|
1176
|
+
def web_authn_configuration: () -> Types::WebAuthnConfigurationType
|
1079
1177
|
end
|
1080
1178
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_user_pool_mfa_config-instance_method
|
1081
1179
|
def get_user_pool_mfa_config: (
|
@@ -1094,14 +1192,15 @@ module Aws
|
|
1094
1192
|
|
1095
1193
|
interface _InitiateAuthResponseSuccess
|
1096
1194
|
include ::Seahorse::Client::_ResponseSuccess[Types::InitiateAuthResponse]
|
1097
|
-
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
1195
|
+
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")
|
1098
1196
|
def session: () -> ::String
|
1099
1197
|
def challenge_parameters: () -> ::Hash[::String, ::String]
|
1100
1198
|
def authentication_result: () -> Types::AuthenticationResultType
|
1199
|
+
def available_challenges: () -> ::Array[("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")]
|
1101
1200
|
end
|
1102
1201
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#initiate_auth-instance_method
|
1103
1202
|
def initiate_auth: (
|
1104
|
-
auth_flow: ("USER_SRP_AUTH" | "REFRESH_TOKEN_AUTH" | "REFRESH_TOKEN" | "CUSTOM_AUTH" | "ADMIN_NO_SRP_AUTH" | "USER_PASSWORD_AUTH" | "ADMIN_USER_PASSWORD_AUTH"),
|
1203
|
+
auth_flow: ("USER_SRP_AUTH" | "REFRESH_TOKEN_AUTH" | "REFRESH_TOKEN" | "CUSTOM_AUTH" | "ADMIN_NO_SRP_AUTH" | "USER_PASSWORD_AUTH" | "ADMIN_USER_PASSWORD_AUTH" | "USER_AUTH"),
|
1105
1204
|
?auth_parameters: Hash[::String, ::String],
|
1106
1205
|
?client_metadata: Hash[::String, ::String],
|
1107
1206
|
client_id: ::String,
|
@@ -1111,7 +1210,8 @@ module Aws
|
|
1111
1210
|
?user_context_data: {
|
1112
1211
|
ip_address: ::String?,
|
1113
1212
|
encoded_data: ::String?
|
1114
|
-
}
|
1213
|
+
},
|
1214
|
+
?session: ::String
|
1115
1215
|
) -> _InitiateAuthResponseSuccess
|
1116
1216
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _InitiateAuthResponseSuccess
|
1117
1217
|
|
@@ -1244,6 +1344,19 @@ module Aws
|
|
1244
1344
|
) -> _ListUsersInGroupResponseSuccess
|
1245
1345
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUsersInGroupResponseSuccess
|
1246
1346
|
|
1347
|
+
interface _ListWebAuthnCredentialsResponseSuccess
|
1348
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListWebAuthnCredentialsResponse]
|
1349
|
+
def credentials: () -> ::Array[Types::WebAuthnCredentialDescription]
|
1350
|
+
def next_token: () -> ::String
|
1351
|
+
end
|
1352
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#list_web_authn_credentials-instance_method
|
1353
|
+
def list_web_authn_credentials: (
|
1354
|
+
access_token: ::String,
|
1355
|
+
?next_token: ::String,
|
1356
|
+
?max_results: ::Integer
|
1357
|
+
) -> _ListWebAuthnCredentialsResponseSuccess
|
1358
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListWebAuthnCredentialsResponseSuccess
|
1359
|
+
|
1247
1360
|
interface _ResendConfirmationCodeResponseSuccess
|
1248
1361
|
include ::Seahorse::Client::_ResponseSuccess[Types::ResendConfirmationCodeResponse]
|
1249
1362
|
def code_delivery_details: () -> Types::CodeDeliveryDetailsType
|
@@ -1266,7 +1379,7 @@ module Aws
|
|
1266
1379
|
|
1267
1380
|
interface _RespondToAuthChallengeResponseSuccess
|
1268
1381
|
include ::Seahorse::Client::_ResponseSuccess[Types::RespondToAuthChallengeResponse]
|
1269
|
-
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED")
|
1382
|
+
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")
|
1270
1383
|
def session: () -> ::String
|
1271
1384
|
def challenge_parameters: () -> ::Hash[::String, ::String]
|
1272
1385
|
def authentication_result: () -> Types::AuthenticationResultType
|
@@ -1274,7 +1387,7 @@ module Aws
|
|
1274
1387
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#respond_to_auth_challenge-instance_method
|
1275
1388
|
def respond_to_auth_challenge: (
|
1276
1389
|
client_id: ::String,
|
1277
|
-
challenge_name: ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED"),
|
1390
|
+
challenge_name: ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP"),
|
1278
1391
|
?session: ::String,
|
1279
1392
|
?challenge_responses: Hash[::String, ::String],
|
1280
1393
|
?analytics_metadata: {
|
@@ -1421,6 +1534,7 @@ module Aws
|
|
1421
1534
|
def software_token_mfa_configuration: () -> Types::SoftwareTokenMfaConfigType
|
1422
1535
|
def email_mfa_configuration: () -> Types::EmailMfaConfigType
|
1423
1536
|
def mfa_configuration: () -> ("OFF" | "ON" | "OPTIONAL")
|
1537
|
+
def web_authn_configuration: () -> Types::WebAuthnConfigurationType
|
1424
1538
|
end
|
1425
1539
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#set_user_pool_mfa_config-instance_method
|
1426
1540
|
def set_user_pool_mfa_config: (
|
@@ -1440,7 +1554,11 @@ module Aws
|
|
1440
1554
|
message: ::String?,
|
1441
1555
|
subject: ::String?
|
1442
1556
|
},
|
1443
|
-
?mfa_configuration: ("OFF" | "ON" | "OPTIONAL")
|
1557
|
+
?mfa_configuration: ("OFF" | "ON" | "OPTIONAL"),
|
1558
|
+
?web_authn_configuration: {
|
1559
|
+
relying_party_id: ::String?,
|
1560
|
+
user_verification: ("required" | "preferred")?
|
1561
|
+
}
|
1444
1562
|
) -> _SetUserPoolMfaConfigResponseSuccess
|
1445
1563
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetUserPoolMfaConfigResponseSuccess
|
1446
1564
|
|
@@ -1464,13 +1582,14 @@ module Aws
|
|
1464
1582
|
def user_confirmed: () -> bool
|
1465
1583
|
def code_delivery_details: () -> Types::CodeDeliveryDetailsType
|
1466
1584
|
def user_sub: () -> ::String
|
1585
|
+
def session: () -> ::String
|
1467
1586
|
end
|
1468
1587
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#sign_up-instance_method
|
1469
1588
|
def sign_up: (
|
1470
1589
|
client_id: ::String,
|
1471
1590
|
?secret_hash: ::String,
|
1472
1591
|
username: ::String,
|
1473
|
-
password: ::String,
|
1592
|
+
?password: ::String,
|
1474
1593
|
?user_attributes: Array[
|
1475
1594
|
{
|
1476
1595
|
name: ::String,
|
@@ -1505,6 +1624,16 @@ module Aws
|
|
1505
1624
|
) -> _StartUserImportJobResponseSuccess
|
1506
1625
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartUserImportJobResponseSuccess
|
1507
1626
|
|
1627
|
+
interface _StartWebAuthnRegistrationResponseSuccess
|
1628
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartWebAuthnRegistrationResponse]
|
1629
|
+
def credential_creation_options: () -> untyped
|
1630
|
+
end
|
1631
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#start_web_authn_registration-instance_method
|
1632
|
+
def start_web_authn_registration: (
|
1633
|
+
access_token: ::String
|
1634
|
+
) -> _StartWebAuthnRegistrationResponseSuccess
|
1635
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartWebAuthnRegistrationResponseSuccess
|
1636
|
+
|
1508
1637
|
interface _StopUserImportJobResponseSuccess
|
1509
1638
|
include ::Seahorse::Client::_ResponseSuccess[Types::StopUserImportJobResponse]
|
1510
1639
|
def user_import_job: () -> Types::UserImportJobType
|
@@ -1588,6 +1717,29 @@ module Aws
|
|
1588
1717
|
) -> _UpdateIdentityProviderResponseSuccess
|
1589
1718
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateIdentityProviderResponseSuccess
|
1590
1719
|
|
1720
|
+
interface _UpdateManagedLoginBrandingResponseSuccess
|
1721
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateManagedLoginBrandingResponse]
|
1722
|
+
def managed_login_branding: () -> Types::ManagedLoginBrandingType
|
1723
|
+
end
|
1724
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_managed_login_branding-instance_method
|
1725
|
+
def update_managed_login_branding: (
|
1726
|
+
?user_pool_id: ::String,
|
1727
|
+
?managed_login_branding_id: ::String,
|
1728
|
+
?use_cognito_provided_values: bool,
|
1729
|
+
?settings: {
|
1730
|
+
},
|
1731
|
+
?assets: Array[
|
1732
|
+
{
|
1733
|
+
category: ("FAVICON_ICO" | "FAVICON_SVG" | "EMAIL_GRAPHIC" | "SMS_GRAPHIC" | "AUTH_APP_GRAPHIC" | "PASSWORD_GRAPHIC" | "PASSKEY_GRAPHIC" | "PAGE_HEADER_LOGO" | "PAGE_HEADER_BACKGROUND" | "PAGE_FOOTER_LOGO" | "PAGE_FOOTER_BACKGROUND" | "PAGE_BACKGROUND" | "FORM_BACKGROUND" | "FORM_LOGO" | "IDP_BUTTON_ICON"),
|
1734
|
+
color_mode: ("LIGHT" | "DARK" | "DYNAMIC"),
|
1735
|
+
extension: ("ICO" | "JPEG" | "PNG" | "SVG" | "WEBP"),
|
1736
|
+
bytes: ::String?,
|
1737
|
+
resource_id: ::String?
|
1738
|
+
},
|
1739
|
+
]
|
1740
|
+
) -> _UpdateManagedLoginBrandingResponseSuccess
|
1741
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateManagedLoginBrandingResponseSuccess
|
1742
|
+
|
1591
1743
|
interface _UpdateResourceServerResponseSuccess
|
1592
1744
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateResourceServerResponse]
|
1593
1745
|
def resource_server: () -> Types::ResourceServerType
|
@@ -1638,6 +1790,9 @@ module Aws
|
|
1638
1790
|
require_symbols: bool?,
|
1639
1791
|
password_history_size: ::Integer?,
|
1640
1792
|
temporary_password_validity_days: ::Integer?
|
1793
|
+
}?,
|
1794
|
+
sign_in_policy: {
|
1795
|
+
allowed_first_auth_factors: Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]?
|
1641
1796
|
}?
|
1642
1797
|
},
|
1643
1798
|
?deletion_protection: ("ACTIVE" | "INACTIVE"),
|
@@ -1722,7 +1877,9 @@ module Aws
|
|
1722
1877
|
name: ("verified_email" | "verified_phone_number" | "admin_only")
|
1723
1878
|
},
|
1724
1879
|
]?
|
1725
|
-
}
|
1880
|
+
},
|
1881
|
+
?pool_name: ::String,
|
1882
|
+
?user_pool_tier: ("LITE" | "ESSENTIALS" | "PLUS")
|
1726
1883
|
) -> _UpdateUserPoolResponseSuccess
|
1727
1884
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserPoolResponseSuccess
|
1728
1885
|
|
@@ -1745,7 +1902,7 @@ module Aws
|
|
1745
1902
|
},
|
1746
1903
|
?read_attributes: Array[::String],
|
1747
1904
|
?write_attributes: Array[::String],
|
1748
|
-
?explicit_auth_flows: Array[("ADMIN_NO_SRP_AUTH" | "CUSTOM_AUTH_FLOW_ONLY" | "USER_PASSWORD_AUTH" | "ALLOW_ADMIN_USER_PASSWORD_AUTH" | "ALLOW_CUSTOM_AUTH" | "ALLOW_USER_PASSWORD_AUTH" | "ALLOW_USER_SRP_AUTH" | "ALLOW_REFRESH_TOKEN_AUTH")],
|
1905
|
+
?explicit_auth_flows: Array[("ADMIN_NO_SRP_AUTH" | "CUSTOM_AUTH_FLOW_ONLY" | "USER_PASSWORD_AUTH" | "ALLOW_ADMIN_USER_PASSWORD_AUTH" | "ALLOW_CUSTOM_AUTH" | "ALLOW_USER_PASSWORD_AUTH" | "ALLOW_USER_SRP_AUTH" | "ALLOW_REFRESH_TOKEN_AUTH" | "ALLOW_USER_AUTH")],
|
1749
1906
|
?supported_identity_providers: Array[::String],
|
1750
1907
|
?callback_urls: Array[::String],
|
1751
1908
|
?logout_urls: Array[::String],
|
@@ -1769,13 +1926,15 @@ module Aws
|
|
1769
1926
|
|
1770
1927
|
interface _UpdateUserPoolDomainResponseSuccess
|
1771
1928
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserPoolDomainResponse]
|
1929
|
+
def managed_login_version: () -> ::Integer
|
1772
1930
|
def cloud_front_domain: () -> ::String
|
1773
1931
|
end
|
1774
1932
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#update_user_pool_domain-instance_method
|
1775
1933
|
def update_user_pool_domain: (
|
1776
1934
|
domain: ::String,
|
1777
1935
|
user_pool_id: ::String,
|
1778
|
-
|
1936
|
+
?managed_login_version: ::Integer,
|
1937
|
+
?custom_domain_config: {
|
1779
1938
|
certificate_arn: ::String
|
1780
1939
|
}
|
1781
1940
|
) -> _UpdateUserPoolDomainResponseSuccess
|
data/sig/errors.rbs
CHANGED
@@ -32,6 +32,9 @@ module Aws
|
|
32
32
|
class ExpiredCodeException < ::Aws::Errors::ServiceError
|
33
33
|
def message: () -> ::String
|
34
34
|
end
|
35
|
+
class FeatureUnavailableInTierException < ::Aws::Errors::ServiceError
|
36
|
+
def message: () -> ::String
|
37
|
+
end
|
35
38
|
class ForbiddenException < ::Aws::Errors::ServiceError
|
36
39
|
def message: () -> ::String
|
37
40
|
end
|
@@ -52,6 +55,7 @@ module Aws
|
|
52
55
|
end
|
53
56
|
class InvalidParameterException < ::Aws::Errors::ServiceError
|
54
57
|
def message: () -> ::String
|
58
|
+
def reason_code: () -> ::String
|
55
59
|
end
|
56
60
|
class InvalidPasswordException < ::Aws::Errors::ServiceError
|
57
61
|
def message: () -> ::String
|
@@ -71,6 +75,9 @@ module Aws
|
|
71
75
|
class MFAMethodNotFoundException < ::Aws::Errors::ServiceError
|
72
76
|
def message: () -> ::String
|
73
77
|
end
|
78
|
+
class ManagedLoginBrandingExistsException < ::Aws::Errors::ServiceError
|
79
|
+
def message: () -> ::String
|
80
|
+
end
|
74
81
|
class NotAuthorizedException < ::Aws::Errors::ServiceError
|
75
82
|
def message: () -> ::String
|
76
83
|
end
|
@@ -92,6 +99,9 @@ module Aws
|
|
92
99
|
class SoftwareTokenMFANotFoundException < ::Aws::Errors::ServiceError
|
93
100
|
def message: () -> ::String
|
94
101
|
end
|
102
|
+
class TierChangeNotAllowedException < ::Aws::Errors::ServiceError
|
103
|
+
def message: () -> ::String
|
104
|
+
end
|
95
105
|
class TooManyFailedAttemptsException < ::Aws::Errors::ServiceError
|
96
106
|
def message: () -> ::String
|
97
107
|
end
|
@@ -137,6 +147,27 @@ module Aws
|
|
137
147
|
class UsernameExistsException < ::Aws::Errors::ServiceError
|
138
148
|
def message: () -> ::String
|
139
149
|
end
|
150
|
+
class WebAuthnChallengeNotFoundException < ::Aws::Errors::ServiceError
|
151
|
+
def message: () -> ::String
|
152
|
+
end
|
153
|
+
class WebAuthnClientMismatchException < ::Aws::Errors::ServiceError
|
154
|
+
def message: () -> ::String
|
155
|
+
end
|
156
|
+
class WebAuthnConfigurationMissingException < ::Aws::Errors::ServiceError
|
157
|
+
def message: () -> ::String
|
158
|
+
end
|
159
|
+
class WebAuthnCredentialNotSupportedException < ::Aws::Errors::ServiceError
|
160
|
+
def message: () -> ::String
|
161
|
+
end
|
162
|
+
class WebAuthnNotEnabledException < ::Aws::Errors::ServiceError
|
163
|
+
def message: () -> ::String
|
164
|
+
end
|
165
|
+
class WebAuthnOriginNotAllowedException < ::Aws::Errors::ServiceError
|
166
|
+
def message: () -> ::String
|
167
|
+
end
|
168
|
+
class WebAuthnRelyingPartyMismatchException < ::Aws::Errors::ServiceError
|
169
|
+
def message: () -> ::String
|
170
|
+
end
|
140
171
|
end
|
141
172
|
end
|
142
173
|
end
|