aws-sdk-cognitoidentityprovider 1.0.0.rc2 → 1.0.0.rc3

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.
@@ -43,6 +43,8 @@ module Aws::CognitoIdentityProvider
43
43
  # An array of custom attributes, such as Mutable and Name.
44
44
  # @return [Array<Types::SchemaAttributeType>]
45
45
  #
46
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributesRequest AWS API Documentation
47
+ #
46
48
  class AddCustomAttributesRequest < Struct.new(
47
49
  :user_pool_id,
48
50
  :custom_attributes)
@@ -52,6 +54,8 @@ module Aws::CognitoIdentityProvider
52
54
  # Represents the response from the server for the request to add custom
53
55
  # attributes.
54
56
  #
57
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributesResponse AWS API Documentation
58
+ #
55
59
  class AddCustomAttributesResponse < Aws::EmptyStructure; end
56
60
 
57
61
  # @note When making an API call, you may pass AdminAddUserToGroupRequest
@@ -75,6 +79,8 @@ module Aws::CognitoIdentityProvider
75
79
  # The group name.
76
80
  # @return [String]
77
81
  #
82
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroupRequest AWS API Documentation
83
+ #
78
84
  class AdminAddUserToGroupRequest < Struct.new(
79
85
  :user_pool_id,
80
86
  :username,
@@ -100,6 +106,8 @@ module Aws::CognitoIdentityProvider
100
106
  # The user name for which you want to confirm user registration.
101
107
  # @return [String]
102
108
  #
109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUpRequest AWS API Documentation
110
+ #
103
111
  class AdminConfirmSignUpRequest < Struct.new(
104
112
  :user_pool_id,
105
113
  :username)
@@ -109,6 +117,8 @@ module Aws::CognitoIdentityProvider
109
117
  # Represents the response from the server for the request to confirm
110
118
  # registration.
111
119
  #
120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUpResponse AWS API Documentation
121
+ #
112
122
  class AdminConfirmSignUpResponse < Aws::EmptyStructure; end
113
123
 
114
124
  # The type of configuration for creating a new user profile.
@@ -143,6 +153,8 @@ module Aws::CognitoIdentityProvider
143
153
  # users.
144
154
  # @return [Types::MessageTemplateType]
145
155
  #
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserConfigType AWS API Documentation
157
+ #
146
158
  class AdminCreateUserConfigType < Struct.new(
147
159
  :allow_admin_create_user_only,
148
160
  :unused_account_validity_days,
@@ -278,6 +290,8 @@ module Aws::CognitoIdentityProvider
278
290
  # is "SMS". More than one value can be specified.
279
291
  # @return [Array<String>]
280
292
  #
293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserRequest AWS API Documentation
294
+ #
281
295
  class AdminCreateUserRequest < Struct.new(
282
296
  :user_pool_id,
283
297
  :username,
@@ -297,6 +311,8 @@ module Aws::CognitoIdentityProvider
297
311
  # The user returned in the request to create a new user.
298
312
  # @return [Types::UserType]
299
313
  #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserResponse AWS API Documentation
315
+ #
300
316
  class AdminCreateUserResponse < Struct.new(
301
317
  :user)
302
318
  include Aws::Structure
@@ -328,6 +344,8 @@ module Aws::CognitoIdentityProvider
328
344
  # to delete.
329
345
  # @return [Array<String>]
330
346
  #
347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributesRequest AWS API Documentation
348
+ #
331
349
  class AdminDeleteUserAttributesRequest < Struct.new(
332
350
  :user_pool_id,
333
351
  :username,
@@ -338,6 +356,8 @@ module Aws::CognitoIdentityProvider
338
356
  # Represents the response received from the server for a request to
339
357
  # delete user attributes.
340
358
  #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributesResponse AWS API Documentation
360
+ #
341
361
  class AdminDeleteUserAttributesResponse < Aws::EmptyStructure; end
342
362
 
343
363
  # Represents the request to delete a user as an administrator.
@@ -359,6 +379,8 @@ module Aws::CognitoIdentityProvider
359
379
  # The user name of the user you wish to delete.
360
380
  # @return [String]
361
381
  #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserRequest AWS API Documentation
383
+ #
362
384
  class AdminDeleteUserRequest < Struct.new(
363
385
  :user_pool_id,
364
386
  :username)
@@ -384,6 +406,8 @@ module Aws::CognitoIdentityProvider
384
406
  # The user name of the user you wish to disable.
385
407
  # @return [String]
386
408
  #
409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUserRequest AWS API Documentation
410
+ #
387
411
  class AdminDisableUserRequest < Struct.new(
388
412
  :user_pool_id,
389
413
  :username)
@@ -393,6 +417,8 @@ module Aws::CognitoIdentityProvider
393
417
  # Represents the response received from the server to disable the user
394
418
  # as an administrator.
395
419
  #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUserResponse AWS API Documentation
421
+ #
396
422
  class AdminDisableUserResponse < Aws::EmptyStructure; end
397
423
 
398
424
  # Represents the request that enables the user as an administrator.
@@ -414,6 +440,8 @@ module Aws::CognitoIdentityProvider
414
440
  # The user name of the user you wish to ebable.
415
441
  # @return [String]
416
442
  #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUserRequest AWS API Documentation
444
+ #
417
445
  class AdminEnableUserRequest < Struct.new(
418
446
  :user_pool_id,
419
447
  :username)
@@ -423,6 +451,8 @@ module Aws::CognitoIdentityProvider
423
451
  # Represents the response from the server for the request to enable a
424
452
  # user as an administrator.
425
453
  #
454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUserResponse AWS API Documentation
455
+ #
426
456
  class AdminEnableUserResponse < Aws::EmptyStructure; end
427
457
 
428
458
  # Sends the forgot device request, as an administrator.
@@ -448,6 +478,8 @@ module Aws::CognitoIdentityProvider
448
478
  # The device key.
449
479
  # @return [String]
450
480
  #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDeviceRequest AWS API Documentation
482
+ #
451
483
  class AdminForgetDeviceRequest < Struct.new(
452
484
  :user_pool_id,
453
485
  :username,
@@ -478,6 +510,8 @@ module Aws::CognitoIdentityProvider
478
510
  # The user name.
479
511
  # @return [String]
480
512
  #
513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDeviceRequest AWS API Documentation
514
+ #
481
515
  class AdminGetDeviceRequest < Struct.new(
482
516
  :device_key,
483
517
  :user_pool_id,
@@ -491,6 +525,8 @@ module Aws::CognitoIdentityProvider
491
525
  # The device.
492
526
  # @return [Types::DeviceType]
493
527
  #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDeviceResponse AWS API Documentation
529
+ #
494
530
  class AdminGetDeviceResponse < Struct.new(
495
531
  :device)
496
532
  include Aws::Structure
@@ -515,6 +551,8 @@ module Aws::CognitoIdentityProvider
515
551
  # The user name of the user you wish to retrieve.
516
552
  # @return [String]
517
553
  #
554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserRequest AWS API Documentation
555
+ #
518
556
  class AdminGetUserRequest < Struct.new(
519
557
  :user_pool_id,
520
558
  :username)
@@ -562,6 +600,8 @@ module Aws::CognitoIdentityProvider
562
600
  # Specifies the options for MFA (e.g., email or phone number).
563
601
  # @return [Array<Types::MFAOptionType>]
564
602
  #
603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserResponse AWS API Documentation
604
+ #
565
605
  class AdminGetUserResponse < Struct.new(
566
606
  :username,
567
607
  :user_attributes,
@@ -610,6 +650,8 @@ module Aws::CognitoIdentityProvider
610
650
  # The client app metadata.
611
651
  # @return [Hash<String,String>]
612
652
  #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuthRequest AWS API Documentation
654
+ #
613
655
  class AdminInitiateAuthRequest < Struct.new(
614
656
  :user_pool_id,
615
657
  :client_id,
@@ -637,6 +679,8 @@ module Aws::CognitoIdentityProvider
637
679
  # The result of the authentication response.
638
680
  # @return [Types::AuthenticationResultType]
639
681
  #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuthResponse AWS API Documentation
683
+ #
640
684
  class AdminInitiateAuthResponse < Struct.new(
641
685
  :challenge_name,
642
686
  :session,
@@ -673,6 +717,8 @@ module Aws::CognitoIdentityProvider
673
717
  # The pagination token.
674
718
  # @return [String]
675
719
  #
720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevicesRequest AWS API Documentation
721
+ #
676
722
  class AdminListDevicesRequest < Struct.new(
677
723
  :user_pool_id,
678
724
  :username,
@@ -691,6 +737,8 @@ module Aws::CognitoIdentityProvider
691
737
  # The pagination token.
692
738
  # @return [String]
693
739
  #
740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevicesResponse AWS API Documentation
741
+ #
694
742
  class AdminListDevicesResponse < Struct.new(
695
743
  :devices,
696
744
  :pagination_token)
@@ -725,6 +773,8 @@ module Aws::CognitoIdentityProvider
725
773
  # list.
726
774
  # @return [String]
727
775
  #
776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUserRequest AWS API Documentation
777
+ #
728
778
  class AdminListGroupsForUserRequest < Struct.new(
729
779
  :username,
730
780
  :user_pool_id,
@@ -743,6 +793,8 @@ module Aws::CognitoIdentityProvider
743
793
  # list.
744
794
  # @return [String]
745
795
  #
796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUserResponse AWS API Documentation
797
+ #
746
798
  class AdminListGroupsForUserResponse < Struct.new(
747
799
  :groups,
748
800
  :next_token)
@@ -770,6 +822,8 @@ module Aws::CognitoIdentityProvider
770
822
  # The group name.
771
823
  # @return [String]
772
824
  #
825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroupRequest AWS API Documentation
826
+ #
773
827
  class AdminRemoveUserFromGroupRequest < Struct.new(
774
828
  :user_pool_id,
775
829
  :username,
@@ -797,6 +851,8 @@ module Aws::CognitoIdentityProvider
797
851
  # The user name of the user whose password you wish to reset.
798
852
  # @return [String]
799
853
  #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminResetUserPasswordRequest AWS API Documentation
855
+ #
800
856
  class AdminResetUserPasswordRequest < Struct.new(
801
857
  :user_pool_id,
802
858
  :username)
@@ -806,6 +862,8 @@ module Aws::CognitoIdentityProvider
806
862
  # Represents the response from the server to reset a user password as an
807
863
  # administrator.
808
864
  #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminResetUserPasswordResponse AWS API Documentation
866
+ #
809
867
  class AdminResetUserPasswordResponse < Aws::EmptyStructure; end
810
868
 
811
869
  # The request to respond to the authentication challenge, as an
@@ -844,6 +902,8 @@ module Aws::CognitoIdentityProvider
844
902
  # The session.
845
903
  # @return [String]
846
904
  #
905
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallengeRequest AWS API Documentation
906
+ #
847
907
  class AdminRespondToAuthChallengeRequest < Struct.new(
848
908
  :user_pool_id,
849
909
  :client_id,
@@ -872,6 +932,8 @@ module Aws::CognitoIdentityProvider
872
932
  # request.
873
933
  # @return [Types::AuthenticationResultType]
874
934
  #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallengeResponse AWS API Documentation
936
+ #
875
937
  class AdminRespondToAuthChallengeResponse < Struct.new(
876
938
  :challenge_name,
877
939
  :session,
@@ -909,6 +971,8 @@ module Aws::CognitoIdentityProvider
909
971
  # Specifies the options for MFA (e.g., email or phone number).
910
972
  # @return [Array<Types::MFAOptionType>]
911
973
  #
974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserSettingsRequest AWS API Documentation
975
+ #
912
976
  class AdminSetUserSettingsRequest < Struct.new(
913
977
  :user_pool_id,
914
978
  :username,
@@ -919,6 +983,8 @@ module Aws::CognitoIdentityProvider
919
983
  # Represents the response from the server to set user settings as an
920
984
  # administrator.
921
985
  #
986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserSettingsResponse AWS API Documentation
987
+ #
922
988
  class AdminSetUserSettingsResponse < Aws::EmptyStructure; end
923
989
 
924
990
  # The request to update the device status, as an administrator.
@@ -949,6 +1015,8 @@ module Aws::CognitoIdentityProvider
949
1015
  # The status indicating whether a device has been remembered or not.
950
1016
  # @return [String]
951
1017
  #
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateDeviceStatusRequest AWS API Documentation
1019
+ #
952
1020
  class AdminUpdateDeviceStatusRequest < Struct.new(
953
1021
  :user_pool_id,
954
1022
  :username,
@@ -960,6 +1028,8 @@ module Aws::CognitoIdentityProvider
960
1028
  # The status response from the request to update the device, as an
961
1029
  # administrator.
962
1030
  #
1031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateDeviceStatusResponse AWS API Documentation
1032
+ #
963
1033
  class AdminUpdateDeviceStatusResponse < Aws::EmptyStructure; end
964
1034
 
965
1035
  # Represents the request to update the user's attributes as an
@@ -993,6 +1063,8 @@ module Aws::CognitoIdentityProvider
993
1063
  # An array of name-value pairs representing user attributes.
994
1064
  # @return [Array<Types::AttributeType>]
995
1065
  #
1066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateUserAttributesRequest AWS API Documentation
1067
+ #
996
1068
  class AdminUpdateUserAttributesRequest < Struct.new(
997
1069
  :user_pool_id,
998
1070
  :username,
@@ -1003,6 +1075,8 @@ module Aws::CognitoIdentityProvider
1003
1075
  # Represents the response from the server for the request to update user
1004
1076
  # attributes as an administrator.
1005
1077
  #
1078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateUserAttributesResponse AWS API Documentation
1079
+ #
1006
1080
  class AdminUpdateUserAttributesResponse < Aws::EmptyStructure; end
1007
1081
 
1008
1082
  # The request to sign out of all devices, as an administrator.
@@ -1023,6 +1097,8 @@ module Aws::CognitoIdentityProvider
1023
1097
  # The user name.
1024
1098
  # @return [String]
1025
1099
  #
1100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUserGlobalSignOutRequest AWS API Documentation
1101
+ #
1026
1102
  class AdminUserGlobalSignOutRequest < Struct.new(
1027
1103
  :user_pool_id,
1028
1104
  :username)
@@ -1031,6 +1107,8 @@ module Aws::CognitoIdentityProvider
1031
1107
 
1032
1108
  # The global sign-out response, as an administrator.
1033
1109
  #
1110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUserGlobalSignOutResponse AWS API Documentation
1111
+ #
1034
1112
  class AdminUserGlobalSignOutResponse < Aws::EmptyStructure; end
1035
1113
 
1036
1114
  # Specifies whether the attribute is standard or custom.
@@ -1051,6 +1129,8 @@ module Aws::CognitoIdentityProvider
1051
1129
  # The value of the attribute.
1052
1130
  # @return [String]
1053
1131
  #
1132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AttributeType AWS API Documentation
1133
+ #
1054
1134
  class AttributeType < Struct.new(
1055
1135
  :name,
1056
1136
  :value)
@@ -1083,6 +1163,8 @@ module Aws::CognitoIdentityProvider
1083
1163
  # The new device metadata from an authentication result.
1084
1164
  # @return [Types::NewDeviceMetadataType]
1085
1165
  #
1166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AuthenticationResultType AWS API Documentation
1167
+ #
1086
1168
  class AuthenticationResultType < Struct.new(
1087
1169
  :access_token,
1088
1170
  :expires_in,
@@ -1116,6 +1198,8 @@ module Aws::CognitoIdentityProvider
1116
1198
  # The access token in the change password request.
1117
1199
  # @return [String]
1118
1200
  #
1201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChangePasswordRequest AWS API Documentation
1202
+ #
1119
1203
  class ChangePasswordRequest < Struct.new(
1120
1204
  :previous_password,
1121
1205
  :proposed_password,
@@ -1125,6 +1209,8 @@ module Aws::CognitoIdentityProvider
1125
1209
 
1126
1210
  # The response from the server to the change password request.
1127
1211
  #
1212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChangePasswordResponse AWS API Documentation
1213
+ #
1128
1214
  class ChangePasswordResponse < Aws::EmptyStructure; end
1129
1215
 
1130
1216
  # The type of code delivery details being returned from the server.
@@ -1141,6 +1227,8 @@ module Aws::CognitoIdentityProvider
1141
1227
  # The name of the attribute in the code delivery details type.
1142
1228
  # @return [String]
1143
1229
  #
1230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CodeDeliveryDetailsType AWS API Documentation
1231
+ #
1144
1232
  class CodeDeliveryDetailsType < Struct.new(
1145
1233
  :destination,
1146
1234
  :delivery_medium,
@@ -1179,6 +1267,8 @@ module Aws::CognitoIdentityProvider
1179
1267
  # The device name.
1180
1268
  # @return [String]
1181
1269
  #
1270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmDeviceRequest AWS API Documentation
1271
+ #
1182
1272
  class ConfirmDeviceRequest < Struct.new(
1183
1273
  :access_token,
1184
1274
  :device_key,
@@ -1194,6 +1284,8 @@ module Aws::CognitoIdentityProvider
1194
1284
  # device response.
1195
1285
  # @return [Boolean]
1196
1286
  #
1287
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmDeviceResponse AWS API Documentation
1288
+ #
1197
1289
  class ConfirmDeviceResponse < Struct.new(
1198
1290
  :user_confirmation_necessary)
1199
1291
  include Aws::Structure
@@ -1237,6 +1329,8 @@ module Aws::CognitoIdentityProvider
1237
1329
  # forgotten password.
1238
1330
  # @return [String]
1239
1331
  #
1332
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmForgotPasswordRequest AWS API Documentation
1333
+ #
1240
1334
  class ConfirmForgotPasswordRequest < Struct.new(
1241
1335
  :client_id,
1242
1336
  :secret_hash,
@@ -1249,6 +1343,8 @@ module Aws::CognitoIdentityProvider
1249
1343
  # The response from the server that results from a user's request to
1250
1344
  # retrieve a forgotten password.
1251
1345
  #
1346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmForgotPasswordResponse AWS API Documentation
1347
+ #
1252
1348
  class ConfirmForgotPasswordResponse < Aws::EmptyStructure; end
1253
1349
 
1254
1350
  # Represents the request to confirm registration of a user.
@@ -1293,6 +1389,8 @@ module Aws::CognitoIdentityProvider
1293
1389
  # **AliasExistsException** error.
1294
1390
  # @return [Boolean]
1295
1391
  #
1392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmSignUpRequest AWS API Documentation
1393
+ #
1296
1394
  class ConfirmSignUpRequest < Struct.new(
1297
1395
  :client_id,
1298
1396
  :secret_hash,
@@ -1305,6 +1403,8 @@ module Aws::CognitoIdentityProvider
1305
1403
  # Represents the response from the server for the registration
1306
1404
  # confirmation.
1307
1405
  #
1406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmSignUpResponse AWS API Documentation
1407
+ #
1308
1408
  class ConfirmSignUpResponse < Aws::EmptyStructure; end
1309
1409
 
1310
1410
  # @note When making an API call, you may pass CreateGroupRequest
@@ -1354,6 +1454,8 @@ module Aws::CognitoIdentityProvider
1354
1454
  # The default `Precedence` value is null.
1355
1455
  # @return [Integer]
1356
1456
  #
1457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupRequest AWS API Documentation
1458
+ #
1357
1459
  class CreateGroupRequest < Struct.new(
1358
1460
  :group_name,
1359
1461
  :user_pool_id,
@@ -1367,6 +1469,8 @@ module Aws::CognitoIdentityProvider
1367
1469
  # The group object for the group.
1368
1470
  # @return [Types::GroupType]
1369
1471
  #
1472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupResponse AWS API Documentation
1473
+ #
1370
1474
  class CreateGroupResponse < Struct.new(
1371
1475
  :group)
1372
1476
  include Aws::Structure
@@ -1397,6 +1501,8 @@ module Aws::CognitoIdentityProvider
1397
1501
  # import job.
1398
1502
  # @return [String]
1399
1503
  #
1504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserImportJobRequest AWS API Documentation
1505
+ #
1400
1506
  class CreateUserImportJobRequest < Struct.new(
1401
1507
  :job_name,
1402
1508
  :user_pool_id,
@@ -1411,6 +1517,8 @@ module Aws::CognitoIdentityProvider
1411
1517
  # The job object that represents the user import job.
1412
1518
  # @return [Types::UserImportJobType]
1413
1519
  #
1520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserImportJobResponse AWS API Documentation
1521
+ #
1414
1522
  class CreateUserImportJobResponse < Struct.new(
1415
1523
  :user_import_job)
1416
1524
  include Aws::Structure
@@ -1461,6 +1569,8 @@ module Aws::CognitoIdentityProvider
1461
1569
  # The explicit authentication flows.
1462
1570
  # @return [Array<String>]
1463
1571
  #
1572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientRequest AWS API Documentation
1573
+ #
1464
1574
  class CreateUserPoolClientRequest < Struct.new(
1465
1575
  :user_pool_id,
1466
1576
  :client_name,
@@ -1478,6 +1588,8 @@ module Aws::CognitoIdentityProvider
1478
1588
  # The user pool client that was just created.
1479
1589
  # @return [Types::UserPoolClientType]
1480
1590
  #
1591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientResponse AWS API Documentation
1592
+ #
1481
1593
  class CreateUserPoolClientResponse < Struct.new(
1482
1594
  :user_pool_client)
1483
1595
  include Aws::Structure
@@ -1631,6 +1743,8 @@ module Aws::CognitoIdentityProvider
1631
1743
  # attributes can be standard or custom attributes.
1632
1744
  # @return [Array<Types::SchemaAttributeType>]
1633
1745
  #
1746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolRequest AWS API Documentation
1747
+ #
1634
1748
  class CreateUserPoolRequest < Struct.new(
1635
1749
  :pool_name,
1636
1750
  :policies,
@@ -1658,6 +1772,8 @@ module Aws::CognitoIdentityProvider
1658
1772
  # A container for the user pool details.
1659
1773
  # @return [Types::UserPoolType]
1660
1774
  #
1775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolResponse AWS API Documentation
1776
+ #
1661
1777
  class CreateUserPoolResponse < Struct.new(
1662
1778
  :user_pool)
1663
1779
  include Aws::Structure
@@ -1679,6 +1795,8 @@ module Aws::CognitoIdentityProvider
1679
1795
  # The user pool ID for the user pool.
1680
1796
  # @return [String]
1681
1797
  #
1798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteGroupRequest AWS API Documentation
1799
+ #
1682
1800
  class DeleteGroupRequest < Struct.new(
1683
1801
  :group_name,
1684
1802
  :user_pool_id)
@@ -1704,6 +1822,8 @@ module Aws::CognitoIdentityProvider
1704
1822
  # The access token used in the request to delete user attributes.
1705
1823
  # @return [String]
1706
1824
  #
1825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserAttributesRequest AWS API Documentation
1826
+ #
1707
1827
  class DeleteUserAttributesRequest < Struct.new(
1708
1828
  :user_attribute_names,
1709
1829
  :access_token)
@@ -1712,6 +1832,8 @@ module Aws::CognitoIdentityProvider
1712
1832
 
1713
1833
  # Represents the response from the server to delete user attributes.
1714
1834
  #
1835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserAttributesResponse AWS API Documentation
1836
+ #
1715
1837
  class DeleteUserAttributesResponse < Aws::EmptyStructure; end
1716
1838
 
1717
1839
  # Represents the request to delete a user pool client.
@@ -1733,6 +1855,8 @@ module Aws::CognitoIdentityProvider
1733
1855
  # The ID of the client associated with the user pool.
1734
1856
  # @return [String]
1735
1857
  #
1858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolClientRequest AWS API Documentation
1859
+ #
1736
1860
  class DeleteUserPoolClientRequest < Struct.new(
1737
1861
  :user_pool_id,
1738
1862
  :client_id)
@@ -1752,6 +1876,8 @@ module Aws::CognitoIdentityProvider
1752
1876
  # The user pool ID for the user pool you want to delete.
1753
1877
  # @return [String]
1754
1878
  #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolRequest AWS API Documentation
1880
+ #
1755
1881
  class DeleteUserPoolRequest < Struct.new(
1756
1882
  :user_pool_id)
1757
1883
  include Aws::Structure
@@ -1770,6 +1896,8 @@ module Aws::CognitoIdentityProvider
1770
1896
  # The access token from a request to delete a user.
1771
1897
  # @return [String]
1772
1898
  #
1899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserRequest AWS API Documentation
1900
+ #
1773
1901
  class DeleteUserRequest < Struct.new(
1774
1902
  :access_token)
1775
1903
  include Aws::Structure
@@ -1794,6 +1922,8 @@ module Aws::CognitoIdentityProvider
1794
1922
  # The job ID for the user import job.
1795
1923
  # @return [String]
1796
1924
  #
1925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserImportJobRequest AWS API Documentation
1926
+ #
1797
1927
  class DescribeUserImportJobRequest < Struct.new(
1798
1928
  :user_pool_id,
1799
1929
  :job_id)
@@ -1807,6 +1937,8 @@ module Aws::CognitoIdentityProvider
1807
1937
  # The job object that represents the user import job.
1808
1938
  # @return [Types::UserImportJobType]
1809
1939
  #
1940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserImportJobResponse AWS API Documentation
1941
+ #
1810
1942
  class DescribeUserImportJobResponse < Struct.new(
1811
1943
  :user_import_job)
1812
1944
  include Aws::Structure
@@ -1830,6 +1962,8 @@ module Aws::CognitoIdentityProvider
1830
1962
  # The ID of the client associated with the user pool.
1831
1963
  # @return [String]
1832
1964
  #
1965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClientRequest AWS API Documentation
1966
+ #
1833
1967
  class DescribeUserPoolClientRequest < Struct.new(
1834
1968
  :user_pool_id,
1835
1969
  :client_id)
@@ -1844,6 +1978,8 @@ module Aws::CognitoIdentityProvider
1844
1978
  # pool client.
1845
1979
  # @return [Types::UserPoolClientType]
1846
1980
  #
1981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClientResponse AWS API Documentation
1982
+ #
1847
1983
  class DescribeUserPoolClientResponse < Struct.new(
1848
1984
  :user_pool_client)
1849
1985
  include Aws::Structure
@@ -1862,6 +1998,8 @@ module Aws::CognitoIdentityProvider
1862
1998
  # The user pool ID for the user pool you want to describe.
1863
1999
  # @return [String]
1864
2000
  #
2001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolRequest AWS API Documentation
2002
+ #
1865
2003
  class DescribeUserPoolRequest < Struct.new(
1866
2004
  :user_pool_id)
1867
2005
  include Aws::Structure
@@ -1874,6 +2012,8 @@ module Aws::CognitoIdentityProvider
1874
2012
  # pool.
1875
2013
  # @return [Types::UserPoolType]
1876
2014
  #
2015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolResponse AWS API Documentation
2016
+ #
1877
2017
  class DescribeUserPoolResponse < Struct.new(
1878
2018
  :user_pool)
1879
2019
  include Aws::Structure
@@ -1898,6 +2038,8 @@ module Aws::CognitoIdentityProvider
1898
2038
  # If true, a device is only remembered on user prompt.
1899
2039
  # @return [Boolean]
1900
2040
  #
2041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceConfigurationType AWS API Documentation
2042
+ #
1901
2043
  class DeviceConfigurationType < Struct.new(
1902
2044
  :challenge_required_on_new_device,
1903
2045
  :device_only_remembered_on_user_prompt)
@@ -1922,6 +2064,8 @@ module Aws::CognitoIdentityProvider
1922
2064
  # The salt.
1923
2065
  # @return [String]
1924
2066
  #
2067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceSecretVerifierConfigType AWS API Documentation
2068
+ #
1925
2069
  class DeviceSecretVerifierConfigType < Struct.new(
1926
2070
  :password_verifier,
1927
2071
  :salt)
@@ -1950,6 +2094,8 @@ module Aws::CognitoIdentityProvider
1950
2094
  # The date in which the device was last authenticated.
1951
2095
  # @return [Time]
1952
2096
  #
2097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceType AWS API Documentation
2098
+ #
1953
2099
  class DeviceType < Struct.new(
1954
2100
  :device_key,
1955
2101
  :device_attributes,
@@ -1977,6 +2123,8 @@ module Aws::CognitoIdentityProvider
1977
2123
  # The REPLY-TO email address.
1978
2124
  # @return [String]
1979
2125
  #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/EmailConfigurationType AWS API Documentation
2127
+ #
1980
2128
  class EmailConfigurationType < Struct.new(
1981
2129
  :source_arn,
1982
2130
  :reply_to_email_address)
@@ -2001,6 +2149,8 @@ module Aws::CognitoIdentityProvider
2001
2149
  # The device key.
2002
2150
  # @return [String]
2003
2151
  #
2152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgetDeviceRequest AWS API Documentation
2153
+ #
2004
2154
  class ForgetDeviceRequest < Struct.new(
2005
2155
  :access_token,
2006
2156
  :device_key)
@@ -2033,6 +2183,8 @@ module Aws::CognitoIdentityProvider
2033
2183
  # a forgotten password.
2034
2184
  # @return [String]
2035
2185
  #
2186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPasswordRequest AWS API Documentation
2187
+ #
2036
2188
  class ForgotPasswordRequest < Struct.new(
2037
2189
  :client_id,
2038
2190
  :secret_hash,
@@ -2048,6 +2200,8 @@ module Aws::CognitoIdentityProvider
2048
2200
  # request to reset a password.
2049
2201
  # @return [Types::CodeDeliveryDetailsType]
2050
2202
  #
2203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPasswordResponse AWS API Documentation
2204
+ #
2051
2205
  class ForgotPasswordResponse < Struct.new(
2052
2206
  :code_delivery_details)
2053
2207
  include Aws::Structure
@@ -2068,6 +2222,8 @@ module Aws::CognitoIdentityProvider
2068
2222
  # into.
2069
2223
  # @return [String]
2070
2224
  #
2225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetCSVHeaderRequest AWS API Documentation
2226
+ #
2071
2227
  class GetCSVHeaderRequest < Struct.new(
2072
2228
  :user_pool_id)
2073
2229
  include Aws::Structure
@@ -2085,6 +2241,8 @@ module Aws::CognitoIdentityProvider
2085
2241
  # The header information for the .csv file for the user import job.
2086
2242
  # @return [Array<String>]
2087
2243
  #
2244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetCSVHeaderResponse AWS API Documentation
2245
+ #
2088
2246
  class GetCSVHeaderResponse < Struct.new(
2089
2247
  :user_pool_id,
2090
2248
  :csv_header)
@@ -2109,6 +2267,8 @@ module Aws::CognitoIdentityProvider
2109
2267
  # The access token.
2110
2268
  # @return [String]
2111
2269
  #
2270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDeviceRequest AWS API Documentation
2271
+ #
2112
2272
  class GetDeviceRequest < Struct.new(
2113
2273
  :device_key,
2114
2274
  :access_token)
@@ -2121,6 +2281,8 @@ module Aws::CognitoIdentityProvider
2121
2281
  # The device.
2122
2282
  # @return [Types::DeviceType]
2123
2283
  #
2284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDeviceResponse AWS API Documentation
2285
+ #
2124
2286
  class GetDeviceResponse < Struct.new(
2125
2287
  :device)
2126
2288
  include Aws::Structure
@@ -2142,6 +2304,8 @@ module Aws::CognitoIdentityProvider
2142
2304
  # The user pool ID for the user pool.
2143
2305
  # @return [String]
2144
2306
  #
2307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroupRequest AWS API Documentation
2308
+ #
2145
2309
  class GetGroupRequest < Struct.new(
2146
2310
  :group_name,
2147
2311
  :user_pool_id)
@@ -2152,6 +2316,8 @@ module Aws::CognitoIdentityProvider
2152
2316
  # The group object for the group.
2153
2317
  # @return [Types::GroupType]
2154
2318
  #
2319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroupResponse AWS API Documentation
2320
+ #
2155
2321
  class GetGroupResponse < Struct.new(
2156
2322
  :group)
2157
2323
  include Aws::Structure
@@ -2177,6 +2343,8 @@ module Aws::CognitoIdentityProvider
2177
2343
  # attribute verification code.
2178
2344
  # @return [String]
2179
2345
  #
2346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCodeRequest AWS API Documentation
2347
+ #
2180
2348
  class GetUserAttributeVerificationCodeRequest < Struct.new(
2181
2349
  :access_token,
2182
2350
  :attribute_name)
@@ -2191,6 +2359,8 @@ module Aws::CognitoIdentityProvider
2191
2359
  # request to get the user attribute verification code.
2192
2360
  # @return [Types::CodeDeliveryDetailsType]
2193
2361
  #
2362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCodeResponse AWS API Documentation
2363
+ #
2194
2364
  class GetUserAttributeVerificationCodeResponse < Struct.new(
2195
2365
  :code_delivery_details)
2196
2366
  include Aws::Structure
@@ -2210,6 +2380,8 @@ module Aws::CognitoIdentityProvider
2210
2380
  # about the user.
2211
2381
  # @return [String]
2212
2382
  #
2383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserRequest AWS API Documentation
2384
+ #
2213
2385
  class GetUserRequest < Struct.new(
2214
2386
  :access_token)
2215
2387
  include Aws::Structure
@@ -2231,6 +2403,8 @@ module Aws::CognitoIdentityProvider
2231
2403
  # Specifies the options for MFA (e.g., email or phone number).
2232
2404
  # @return [Array<Types::MFAOptionType>]
2233
2405
  #
2406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserResponse AWS API Documentation
2407
+ #
2234
2408
  class GetUserResponse < Struct.new(
2235
2409
  :username,
2236
2410
  :user_attributes,
@@ -2251,6 +2425,8 @@ module Aws::CognitoIdentityProvider
2251
2425
  # The access token.
2252
2426
  # @return [String]
2253
2427
  #
2428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GlobalSignOutRequest AWS API Documentation
2429
+ #
2254
2430
  class GlobalSignOutRequest < Struct.new(
2255
2431
  :access_token)
2256
2432
  include Aws::Structure
@@ -2258,6 +2434,8 @@ module Aws::CognitoIdentityProvider
2258
2434
 
2259
2435
  # The response to the request to sign out all devices.
2260
2436
  #
2437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GlobalSignOutResponse AWS API Documentation
2438
+ #
2261
2439
  class GlobalSignOutResponse < Aws::EmptyStructure; end
2262
2440
 
2263
2441
  # The group type.
@@ -2306,6 +2484,8 @@ module Aws::CognitoIdentityProvider
2306
2484
  # The date the group was created.
2307
2485
  # @return [Time]
2308
2486
  #
2487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GroupType AWS API Documentation
2488
+ #
2309
2489
  class GroupType < Struct.new(
2310
2490
  :group_name,
2311
2491
  :user_pool_id,
@@ -2349,6 +2529,8 @@ module Aws::CognitoIdentityProvider
2349
2529
  # The client ID.
2350
2530
  # @return [String]
2351
2531
  #
2532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuthRequest AWS API Documentation
2533
+ #
2352
2534
  class InitiateAuthRequest < Struct.new(
2353
2535
  :auth_flow,
2354
2536
  :auth_parameters,
@@ -2376,6 +2558,8 @@ module Aws::CognitoIdentityProvider
2376
2558
  # initiate authentication.
2377
2559
  # @return [Types::AuthenticationResultType]
2378
2560
  #
2561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuthResponse AWS API Documentation
2562
+ #
2379
2563
  class InitiateAuthResponse < Struct.new(
2380
2564
  :challenge_name,
2381
2565
  :session,
@@ -2432,6 +2616,8 @@ module Aws::CognitoIdentityProvider
2432
2616
  # Verifies the authentication challenge response.
2433
2617
  # @return [String]
2434
2618
  #
2619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/LambdaConfigType AWS API Documentation
2620
+ #
2435
2621
  class LambdaConfigType < Struct.new(
2436
2622
  :pre_sign_up,
2437
2623
  :custom_message,
@@ -2467,6 +2653,8 @@ module Aws::CognitoIdentityProvider
2467
2653
  # The pagination token for the list request.
2468
2654
  # @return [String]
2469
2655
  #
2656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListDevicesRequest AWS API Documentation
2657
+ #
2470
2658
  class ListDevicesRequest < Struct.new(
2471
2659
  :access_token,
2472
2660
  :limit,
@@ -2484,6 +2672,8 @@ module Aws::CognitoIdentityProvider
2484
2672
  # The pagination token for the list device response.
2485
2673
  # @return [String]
2486
2674
  #
2675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListDevicesResponse AWS API Documentation
2676
+ #
2487
2677
  class ListDevicesResponse < Struct.new(
2488
2678
  :devices,
2489
2679
  :pagination_token)
@@ -2513,6 +2703,8 @@ module Aws::CognitoIdentityProvider
2513
2703
  # list.
2514
2704
  # @return [String]
2515
2705
  #
2706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroupsRequest AWS API Documentation
2707
+ #
2516
2708
  class ListGroupsRequest < Struct.new(
2517
2709
  :user_pool_id,
2518
2710
  :limit,
@@ -2530,6 +2722,8 @@ module Aws::CognitoIdentityProvider
2530
2722
  # list.
2531
2723
  # @return [String]
2532
2724
  #
2725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroupsResponse AWS API Documentation
2726
+ #
2533
2727
  class ListGroupsResponse < Struct.new(
2534
2728
  :groups,
2535
2729
  :next_token)
@@ -2562,6 +2756,8 @@ module Aws::CognitoIdentityProvider
2562
2756
  # import jobs in the list.
2563
2757
  # @return [String]
2564
2758
  #
2759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserImportJobsRequest AWS API Documentation
2760
+ #
2565
2761
  class ListUserImportJobsRequest < Struct.new(
2566
2762
  :user_pool_id,
2567
2763
  :max_results,
@@ -2581,6 +2777,8 @@ module Aws::CognitoIdentityProvider
2581
2777
  # jobs in the list.
2582
2778
  # @return [String]
2583
2779
  #
2780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserImportJobsResponse AWS API Documentation
2781
+ #
2584
2782
  class ListUserImportJobsResponse < Struct.new(
2585
2783
  :user_import_jobs,
2586
2784
  :pagination_token)
@@ -2614,6 +2812,8 @@ module Aws::CognitoIdentityProvider
2614
2812
  # list.
2615
2813
  # @return [String]
2616
2814
  #
2815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolClientsRequest AWS API Documentation
2816
+ #
2617
2817
  class ListUserPoolClientsRequest < Struct.new(
2618
2818
  :user_pool_id,
2619
2819
  :max_results,
@@ -2633,6 +2833,8 @@ module Aws::CognitoIdentityProvider
2633
2833
  # list.
2634
2834
  # @return [String]
2635
2835
  #
2836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolClientsResponse AWS API Documentation
2837
+ #
2636
2838
  class ListUserPoolClientsResponse < Struct.new(
2637
2839
  :user_pool_clients,
2638
2840
  :next_token)
@@ -2660,6 +2862,8 @@ module Aws::CognitoIdentityProvider
2660
2862
  # listing the user pools.
2661
2863
  # @return [Integer]
2662
2864
  #
2865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolsRequest AWS API Documentation
2866
+ #
2663
2867
  class ListUserPoolsRequest < Struct.new(
2664
2868
  :next_token,
2665
2869
  :max_results)
@@ -2678,6 +2882,8 @@ module Aws::CognitoIdentityProvider
2678
2882
  # list.
2679
2883
  # @return [String]
2680
2884
  #
2885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolsResponse AWS API Documentation
2886
+ #
2681
2887
  class ListUserPoolsResponse < Struct.new(
2682
2888
  :user_pools,
2683
2889
  :next_token)
@@ -2712,6 +2918,8 @@ module Aws::CognitoIdentityProvider
2712
2918
  # list.
2713
2919
  # @return [String]
2714
2920
  #
2921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroupRequest AWS API Documentation
2922
+ #
2715
2923
  class ListUsersInGroupRequest < Struct.new(
2716
2924
  :user_pool_id,
2717
2925
  :group_name,
@@ -2730,6 +2938,8 @@ module Aws::CognitoIdentityProvider
2730
2938
  # list.
2731
2939
  # @return [String]
2732
2940
  #
2941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroupResponse AWS API Documentation
2942
+ #
2733
2943
  class ListUsersInGroupResponse < Struct.new(
2734
2944
  :users,
2735
2945
  :next_token)
@@ -2771,6 +2981,8 @@ module Aws::CognitoIdentityProvider
2771
2981
  # The filter for the list users request.
2772
2982
  # @return [String]
2773
2983
  #
2984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersRequest AWS API Documentation
2985
+ #
2774
2986
  class ListUsersRequest < Struct.new(
2775
2987
  :user_pool_id,
2776
2988
  :attributes_to_get,
@@ -2792,6 +3004,8 @@ module Aws::CognitoIdentityProvider
2792
3004
  # list.
2793
3005
  # @return [String]
2794
3006
  #
3007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersResponse AWS API Documentation
3008
+ #
2795
3009
  class ListUsersResponse < Struct.new(
2796
3010
  :users,
2797
3011
  :pagination_token)
@@ -2818,6 +3032,8 @@ module Aws::CognitoIdentityProvider
2818
3032
  # The attribute name of the MFA option type.
2819
3033
  # @return [String]
2820
3034
  #
3035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MFAOptionType AWS API Documentation
3036
+ #
2821
3037
  class MFAOptionType < Struct.new(
2822
3038
  :delivery_medium,
2823
3039
  :attribute_name)
@@ -2847,6 +3063,8 @@ module Aws::CognitoIdentityProvider
2847
3063
  # The subject line for email messages.
2848
3064
  # @return [String]
2849
3065
  #
3066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MessageTemplateType AWS API Documentation
3067
+ #
2850
3068
  class MessageTemplateType < Struct.new(
2851
3069
  :sms_message,
2852
3070
  :email_message,
@@ -2864,6 +3082,8 @@ module Aws::CognitoIdentityProvider
2864
3082
  # The device group key.
2865
3083
  # @return [String]
2866
3084
  #
3085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NewDeviceMetadataType AWS API Documentation
3086
+ #
2867
3087
  class NewDeviceMetadataType < Struct.new(
2868
3088
  :device_key,
2869
3089
  :device_group_key)
@@ -2889,6 +3109,8 @@ module Aws::CognitoIdentityProvider
2889
3109
  # The maximum value of an attribute that is of the number data type.
2890
3110
  # @return [String]
2891
3111
  #
3112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NumberAttributeConstraintsType AWS API Documentation
3113
+ #
2892
3114
  class NumberAttributeConstraintsType < Struct.new(
2893
3115
  :min_value,
2894
3116
  :max_value)
@@ -2935,6 +3157,8 @@ module Aws::CognitoIdentityProvider
2935
3157
  # required users to use at least one symbol in their password.
2936
3158
  # @return [Boolean]
2937
3159
  #
3160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/PasswordPolicyType AWS API Documentation
3161
+ #
2938
3162
  class PasswordPolicyType < Struct.new(
2939
3163
  :minimum_length,
2940
3164
  :require_uppercase,
@@ -2970,6 +3194,8 @@ module Aws::CognitoIdentityProvider
2970
3194
  # code.
2971
3195
  # @return [String]
2972
3196
  #
3197
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResendConfirmationCodeRequest AWS API Documentation
3198
+ #
2973
3199
  class ResendConfirmationCodeRequest < Struct.new(
2974
3200
  :client_id,
2975
3201
  :secret_hash,
@@ -2985,6 +3211,8 @@ module Aws::CognitoIdentityProvider
2985
3211
  # request to resend the confirmation code.
2986
3212
  # @return [Types::CodeDeliveryDetailsType]
2987
3213
  #
3214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResendConfirmationCodeResponse AWS API Documentation
3215
+ #
2988
3216
  class ResendConfirmationCodeResponse < Struct.new(
2989
3217
  :code_delivery_details)
2990
3218
  include Aws::Structure
@@ -3020,6 +3248,8 @@ module Aws::CognitoIdentityProvider
3020
3248
  # The responses to the authentication challenge.
3021
3249
  # @return [Hash<String,String>]
3022
3250
  #
3251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallengeRequest AWS API Documentation
3252
+ #
3023
3253
  class RespondToAuthChallengeRequest < Struct.new(
3024
3254
  :client_id,
3025
3255
  :challenge_name,
@@ -3047,6 +3277,8 @@ module Aws::CognitoIdentityProvider
3047
3277
  # respond to the authentication challenge.
3048
3278
  # @return [Types::AuthenticationResultType]
3049
3279
  #
3280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallengeResponse AWS API Documentation
3281
+ #
3050
3282
  class RespondToAuthChallengeResponse < Struct.new(
3051
3283
  :challenge_name,
3052
3284
  :session,
@@ -3107,6 +3339,8 @@ module Aws::CognitoIdentityProvider
3107
3339
  # Specifies the constraints for an attribute of the string type.
3108
3340
  # @return [Types::StringAttributeConstraintsType]
3109
3341
  #
3342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SchemaAttributeType AWS API Documentation
3343
+ #
3110
3344
  class SchemaAttributeType < Struct.new(
3111
3345
  :name,
3112
3346
  :attribute_data_type,
@@ -3141,6 +3375,8 @@ module Aws::CognitoIdentityProvider
3141
3375
  # Specifies the options for MFA (e.g., email or phone number).
3142
3376
  # @return [Array<Types::MFAOptionType>]
3143
3377
  #
3378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserSettingsRequest AWS API Documentation
3379
+ #
3144
3380
  class SetUserSettingsRequest < Struct.new(
3145
3381
  :access_token,
3146
3382
  :mfa_options)
@@ -3149,6 +3385,8 @@ module Aws::CognitoIdentityProvider
3149
3385
 
3150
3386
  # The response from the server for a set user settings request.
3151
3387
  #
3388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserSettingsResponse AWS API Documentation
3389
+ #
3152
3390
  class SetUserSettingsResponse < Aws::EmptyStructure; end
3153
3391
 
3154
3392
  # Represents the request to register a user.
@@ -3201,6 +3439,8 @@ module Aws::CognitoIdentityProvider
3201
3439
  # The validation data in the request to register a user.
3202
3440
  # @return [Array<Types::AttributeType>]
3203
3441
  #
3442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUpRequest AWS API Documentation
3443
+ #
3204
3444
  class SignUpRequest < Struct.new(
3205
3445
  :client_id,
3206
3446
  :secret_hash,
@@ -3223,6 +3463,8 @@ module Aws::CognitoIdentityProvider
3223
3463
  # user registration request.
3224
3464
  # @return [Types::CodeDeliveryDetailsType]
3225
3465
  #
3466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUpResponse AWS API Documentation
3467
+ #
3226
3468
  class SignUpResponse < Struct.new(
3227
3469
  :user_confirmed,
3228
3470
  :code_delivery_details)
@@ -3248,6 +3490,8 @@ module Aws::CognitoIdentityProvider
3248
3490
  # The external ID.
3249
3491
  # @return [String]
3250
3492
  #
3493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SmsConfigurationType AWS API Documentation
3494
+ #
3251
3495
  class SmsConfigurationType < Struct.new(
3252
3496
  :sns_caller_arn,
3253
3497
  :external_id)
@@ -3273,6 +3517,8 @@ module Aws::CognitoIdentityProvider
3273
3517
  # The job ID for the user import job.
3274
3518
  # @return [String]
3275
3519
  #
3520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StartUserImportJobRequest AWS API Documentation
3521
+ #
3276
3522
  class StartUserImportJobRequest < Struct.new(
3277
3523
  :user_pool_id,
3278
3524
  :job_id)
@@ -3286,6 +3532,8 @@ module Aws::CognitoIdentityProvider
3286
3532
  # The job object that represents the user import job.
3287
3533
  # @return [Types::UserImportJobType]
3288
3534
  #
3535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StartUserImportJobResponse AWS API Documentation
3536
+ #
3289
3537
  class StartUserImportJobResponse < Struct.new(
3290
3538
  :user_import_job)
3291
3539
  include Aws::Structure
@@ -3310,6 +3558,8 @@ module Aws::CognitoIdentityProvider
3310
3558
  # The job ID for the user import job.
3311
3559
  # @return [String]
3312
3560
  #
3561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StopUserImportJobRequest AWS API Documentation
3562
+ #
3313
3563
  class StopUserImportJobRequest < Struct.new(
3314
3564
  :user_pool_id,
3315
3565
  :job_id)
@@ -3323,6 +3573,8 @@ module Aws::CognitoIdentityProvider
3323
3573
  # The job object that represents the user import job.
3324
3574
  # @return [Types::UserImportJobType]
3325
3575
  #
3576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StopUserImportJobResponse AWS API Documentation
3577
+ #
3326
3578
  class StopUserImportJobResponse < Struct.new(
3327
3579
  :user_import_job)
3328
3580
  include Aws::Structure
@@ -3347,6 +3599,8 @@ module Aws::CognitoIdentityProvider
3347
3599
  # The maximum length of an attribute value of the string type.
3348
3600
  # @return [String]
3349
3601
  #
3602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StringAttributeConstraintsType AWS API Documentation
3603
+ #
3350
3604
  class StringAttributeConstraintsType < Struct.new(
3351
3605
  :min_length,
3352
3606
  :max_length)
@@ -3376,6 +3630,8 @@ module Aws::CognitoIdentityProvider
3376
3630
  # The status of whether a device is remembered.
3377
3631
  # @return [String]
3378
3632
  #
3633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateDeviceStatusRequest AWS API Documentation
3634
+ #
3379
3635
  class UpdateDeviceStatusRequest < Struct.new(
3380
3636
  :access_token,
3381
3637
  :device_key,
@@ -3385,6 +3641,8 @@ module Aws::CognitoIdentityProvider
3385
3641
 
3386
3642
  # The response to the request to update the device status.
3387
3643
  #
3644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateDeviceStatusResponse AWS API Documentation
3645
+ #
3388
3646
  class UpdateDeviceStatusResponse < Aws::EmptyStructure; end
3389
3647
 
3390
3648
  # @note When making an API call, you may pass UpdateGroupRequest
@@ -3421,6 +3679,8 @@ module Aws::CognitoIdentityProvider
3421
3679
  # [CreateGroupRequest](API_CreateGroupRequeste.html).
3422
3680
  # @return [Integer]
3423
3681
  #
3682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupRequest AWS API Documentation
3683
+ #
3424
3684
  class UpdateGroupRequest < Struct.new(
3425
3685
  :group_name,
3426
3686
  :user_pool_id,
@@ -3434,6 +3694,8 @@ module Aws::CognitoIdentityProvider
3434
3694
  # The group object for the group.
3435
3695
  # @return [Types::GroupType]
3436
3696
  #
3697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupResponse AWS API Documentation
3698
+ #
3437
3699
  class UpdateGroupResponse < Struct.new(
3438
3700
  :group)
3439
3701
  include Aws::Structure
@@ -3462,6 +3724,8 @@ module Aws::CognitoIdentityProvider
3462
3724
  # The access token for the request to update user attributes.
3463
3725
  # @return [String]
3464
3726
  #
3727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserAttributesRequest AWS API Documentation
3728
+ #
3465
3729
  class UpdateUserAttributesRequest < Struct.new(
3466
3730
  :user_attributes,
3467
3731
  :access_token)
@@ -3476,6 +3740,8 @@ module Aws::CognitoIdentityProvider
3476
3740
  # update user attributes.
3477
3741
  # @return [Array<Types::CodeDeliveryDetailsType>]
3478
3742
  #
3743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserAttributesResponse AWS API Documentation
3744
+ #
3479
3745
  class UpdateUserAttributesResponse < Struct.new(
3480
3746
  :code_delivery_details_list)
3481
3747
  include Aws::Structure
@@ -3525,6 +3791,8 @@ module Aws::CognitoIdentityProvider
3525
3791
  # Explicit authentication flows.
3526
3792
  # @return [Array<String>]
3527
3793
  #
3794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientRequest AWS API Documentation
3795
+ #
3528
3796
  class UpdateUserPoolClientRequest < Struct.new(
3529
3797
  :user_pool_id,
3530
3798
  :client_id,
@@ -3544,6 +3812,8 @@ module Aws::CognitoIdentityProvider
3544
3812
  # update user pool client request is made.
3545
3813
  # @return [Types::UserPoolClientType]
3546
3814
  #
3815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientResponse AWS API Documentation
3816
+ #
3547
3817
  class UpdateUserPoolClientResponse < Struct.new(
3548
3818
  :user_pool_client)
3549
3819
  include Aws::Structure
@@ -3679,6 +3949,8 @@ module Aws::CognitoIdentityProvider
3679
3949
  # The configuration for AdminCreateUser requests.
3680
3950
  # @return [Types::AdminCreateUserConfigType]
3681
3951
  #
3952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolRequest AWS API Documentation
3953
+ #
3682
3954
  class UpdateUserPoolRequest < Struct.new(
3683
3955
  :user_pool_id,
3684
3956
  :policies,
@@ -3700,6 +3972,8 @@ module Aws::CognitoIdentityProvider
3700
3972
  # Represents the response from the server when you make a request to
3701
3973
  # update the user pool.
3702
3974
  #
3975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolResponse AWS API Documentation
3976
+ #
3703
3977
  class UpdateUserPoolResponse < Aws::EmptyStructure; end
3704
3978
 
3705
3979
  # The user import job type.
@@ -3780,6 +4054,8 @@ module Aws::CognitoIdentityProvider
3780
4054
  # The message returned when the user import job is completed.
3781
4055
  # @return [String]
3782
4056
  #
4057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserImportJobType AWS API Documentation
4058
+ #
3783
4059
  class UserImportJobType < Struct.new(
3784
4060
  :job_name,
3785
4061
  :job_id,
@@ -3812,6 +4088,8 @@ module Aws::CognitoIdentityProvider
3812
4088
  # The client name from the user pool client description.
3813
4089
  # @return [String]
3814
4090
  #
4091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientDescription AWS API Documentation
4092
+ #
3815
4093
  class UserPoolClientDescription < Struct.new(
3816
4094
  :client_id,
3817
4095
  :user_pool_id,
@@ -3862,6 +4140,8 @@ module Aws::CognitoIdentityProvider
3862
4140
  # The explicit authentication flows.
3863
4141
  # @return [Array<String>]
3864
4142
  #
4143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientType AWS API Documentation
4144
+ #
3865
4145
  class UserPoolClientType < Struct.new(
3866
4146
  :user_pool_id,
3867
4147
  :client_name,
@@ -3902,6 +4182,8 @@ module Aws::CognitoIdentityProvider
3902
4182
  # The creation date in a user pool description.
3903
4183
  # @return [Time]
3904
4184
  #
4185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolDescriptionType AWS API Documentation
4186
+ #
3905
4187
  class UserPoolDescriptionType < Struct.new(
3906
4188
  :id,
3907
4189
  :name,
@@ -3931,6 +4213,8 @@ module Aws::CognitoIdentityProvider
3931
4213
  # A container with information about the user pool password policy.
3932
4214
  # @return [Types::PasswordPolicyType]
3933
4215
  #
4216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolPolicyType AWS API Documentation
4217
+ #
3934
4218
  class UserPoolPolicyType < Struct.new(
3935
4219
  :password_policy)
3936
4220
  include Aws::Structure
@@ -4047,6 +4331,8 @@ module Aws::CognitoIdentityProvider
4047
4331
  # The configuration for AdminCreateUser requests.
4048
4332
  # @return [Types::AdminCreateUserConfigType]
4049
4333
  #
4334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolType AWS API Documentation
4335
+ #
4050
4336
  class UserPoolType < Struct.new(
4051
4337
  :id,
4052
4338
  :name,
@@ -4114,6 +4400,8 @@ module Aws::CognitoIdentityProvider
4114
4400
  # The MFA options for the user.
4115
4401
  # @return [Array<Types::MFAOptionType>]
4116
4402
  #
4403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserType AWS API Documentation
4404
+ #
4117
4405
  class UserType < Struct.new(
4118
4406
  :username,
4119
4407
  :attributes,
@@ -4149,6 +4437,8 @@ module Aws::CognitoIdentityProvider
4149
4437
  # The verification code in the request to verify user attributes.
4150
4438
  # @return [String]
4151
4439
  #
4440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttributeRequest AWS API Documentation
4441
+ #
4152
4442
  class VerifyUserAttributeRequest < Struct.new(
4153
4443
  :access_token,
4154
4444
  :attribute_name,
@@ -4159,6 +4449,8 @@ module Aws::CognitoIdentityProvider
4159
4449
  # A container representing the response from the server from the request
4160
4450
  # to verify user attributes.
4161
4451
  #
4452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttributeResponse AWS API Documentation
4453
+ #
4162
4454
  class VerifyUserAttributeResponse < Aws::EmptyStructure; end
4163
4455
 
4164
4456
  end