@aws-sdk/client-cognito-identity-provider 3.321.1 → 3.326.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.
Files changed (102) hide show
  1. package/dist-types/commands/AddCustomAttributesCommand.d.ts +4 -0
  2. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +4 -0
  3. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +4 -0
  4. package/dist-types/commands/AdminCreateUserCommand.d.ts +24 -0
  5. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +4 -0
  6. package/dist-types/commands/AdminDeleteUserCommand.d.ts +4 -0
  7. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +4 -0
  8. package/dist-types/commands/AdminDisableUserCommand.d.ts +4 -0
  9. package/dist-types/commands/AdminEnableUserCommand.d.ts +4 -0
  10. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +4 -0
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +17 -0
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +26 -0
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +21 -0
  14. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +4 -0
  15. package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -0
  16. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +17 -0
  17. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +37 -0
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +4 -0
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +4 -0
  20. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +21 -0
  21. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +4 -0
  22. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +4 -0
  23. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +4 -0
  24. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +4 -0
  25. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +4 -0
  26. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +4 -0
  27. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +4 -0
  28. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +7 -0
  29. package/dist-types/commands/ChangePasswordCommand.d.ts +4 -0
  30. package/dist-types/commands/ConfirmDeviceCommand.d.ts +6 -0
  31. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +4 -0
  32. package/dist-types/commands/ConfirmSignUpCommand.d.ts +4 -0
  33. package/dist-types/commands/CreateGroupCommand.d.ts +14 -0
  34. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +21 -0
  35. package/dist-types/commands/CreateResourceServerCommand.d.ts +16 -0
  36. package/dist-types/commands/CreateUserImportJobCommand.d.ts +20 -0
  37. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +58 -0
  38. package/dist-types/commands/CreateUserPoolCommand.d.ts +136 -0
  39. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +6 -0
  40. package/dist-types/commands/DeleteGroupCommand.d.ts +4 -0
  41. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +4 -0
  42. package/dist-types/commands/DeleteResourceServerCommand.d.ts +4 -0
  43. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +4 -0
  44. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  45. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +4 -0
  46. package/dist-types/commands/DeleteUserPoolCommand.d.ts +4 -0
  47. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +4 -0
  48. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +21 -0
  49. package/dist-types/commands/DescribeResourceServerCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +62 -0
  51. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +20 -0
  52. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +58 -0
  53. package/dist-types/commands/DescribeUserPoolCommand.d.ts +136 -0
  54. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +17 -0
  55. package/dist-types/commands/ForgetDeviceCommand.d.ts +4 -0
  56. package/dist-types/commands/ForgotPasswordCommand.d.ts +10 -0
  57. package/dist-types/commands/GetCSVHeaderCommand.d.ts +9 -0
  58. package/dist-types/commands/GetDeviceCommand.d.ts +17 -0
  59. package/dist-types/commands/GetGroupCommand.d.ts +14 -0
  60. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +21 -0
  61. package/dist-types/commands/GetSigningCertificateCommand.d.ts +6 -0
  62. package/dist-types/commands/GetUICustomizationCommand.d.ts +14 -0
  63. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -0
  64. package/dist-types/commands/GetUserCommand.d.ts +22 -0
  65. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +17 -0
  66. package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -0
  67. package/dist-types/commands/InitiateAuthCommand.d.ts +21 -0
  68. package/dist-types/commands/ListDevicesCommand.d.ts +20 -0
  69. package/dist-types/commands/ListGroupsCommand.d.ts +17 -0
  70. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +14 -0
  71. package/dist-types/commands/ListResourceServersCommand.d.ts +19 -0
  72. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  73. package/dist-types/commands/ListUserImportJobsCommand.d.ts +23 -0
  74. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +13 -0
  75. package/dist-types/commands/ListUserPoolsCommand.d.ts +36 -0
  76. package/dist-types/commands/ListUsersCommand.d.ts +27 -0
  77. package/dist-types/commands/ListUsersInGroupCommand.d.ts +27 -0
  78. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -0
  79. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +21 -0
  80. package/dist-types/commands/RevokeTokenCommand.d.ts +4 -0
  81. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +62 -0
  82. package/dist-types/commands/SetUICustomizationCommand.d.ts +14 -0
  83. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -0
  84. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +17 -0
  85. package/dist-types/commands/SetUserSettingsCommand.d.ts +4 -0
  86. package/dist-types/commands/SignUpCommand.d.ts +12 -0
  87. package/dist-types/commands/StartUserImportJobCommand.d.ts +20 -0
  88. package/dist-types/commands/StopUserImportJobCommand.d.ts +20 -0
  89. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  90. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  91. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +4 -0
  92. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +4 -0
  93. package/dist-types/commands/UpdateGroupCommand.d.ts +14 -0
  94. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +21 -0
  95. package/dist-types/commands/UpdateResourceServerCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -0
  97. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +58 -0
  98. package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -0
  99. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +6 -0
  100. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +7 -0
  101. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +4 -0
  102. package/package.json +16 -16
@@ -48,6 +48,8 @@ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesRes
48
48
  * };
49
49
  * const command = new AddCustomAttributesCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // {};
52
+ *
51
53
  * ```
52
54
  *
53
55
  * @param AddCustomAttributesCommandInput - {@link AddCustomAttributesCommandInput}
@@ -78,6 +80,8 @@ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesRes
78
80
  * <p>This exception is thrown when you're trying to modify a user pool while a user import
79
81
  * job is in progress for that pool.</p>
80
82
  *
83
+ * @throws {@link CognitoIdentityProviderServiceException}
84
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
81
85
  *
82
86
  */
83
87
  export declare class AddCustomAttributesCommand extends $Command<AddCustomAttributesCommandInput, AddCustomAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new AdminAddUserToGroupCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param AdminAddUserToGroupCommandInput - {@link AdminAddUserToGroupCommandInput}
@@ -63,6 +65,8 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {
63
65
  * @throws {@link UserNotFoundException} (client fault)
64
66
  * <p>This exception is thrown when a user isn't found.</p>
65
67
  *
68
+ * @throws {@link CognitoIdentityProviderServiceException}
69
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
66
70
  *
67
71
  */
68
72
  export declare class AdminAddUserToGroupCommand extends $Command<AdminAddUserToGroupCommandInput, AdminAddUserToGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
37
37
  * };
38
38
  * const command = new AdminConfirmSignUpCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param AdminConfirmSignUpCommandInput - {@link AdminConfirmSignUpCommandInput}
@@ -85,6 +87,8 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
85
87
  * @throws {@link UserNotFoundException} (client fault)
86
88
  * <p>This exception is thrown when a user isn't found.</p>
87
89
  *
90
+ * @throws {@link CognitoIdentityProviderServiceException}
91
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
88
92
  *
89
93
  */
90
94
  export declare class AdminConfirmSignUpCommand extends $Command<AdminConfirmSignUpCommandInput, AdminConfirmSignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -83,6 +83,28 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
83
83
  * };
84
84
  * const command = new AdminCreateUserCommand(input);
85
85
  * const response = await client.send(command);
86
+ * // { // AdminCreateUserResponse
87
+ * // User: { // UserType
88
+ * // Username: "STRING_VALUE",
89
+ * // Attributes: [ // AttributeListType
90
+ * // { // AttributeType
91
+ * // Name: "STRING_VALUE", // required
92
+ * // Value: "STRING_VALUE",
93
+ * // },
94
+ * // ],
95
+ * // UserCreateDate: new Date("TIMESTAMP"),
96
+ * // UserLastModifiedDate: new Date("TIMESTAMP"),
97
+ * // Enabled: true || false,
98
+ * // UserStatus: "UNCONFIRMED" || "CONFIRMED" || "ARCHIVED" || "COMPROMISED" || "UNKNOWN" || "RESET_REQUIRED" || "FORCE_CHANGE_PASSWORD",
99
+ * // MFAOptions: [ // MFAOptionListType
100
+ * // { // MFAOptionType
101
+ * // DeliveryMedium: "SMS" || "EMAIL",
102
+ * // AttributeName: "STRING_VALUE",
103
+ * // },
104
+ * // ],
105
+ * // },
106
+ * // };
107
+ *
86
108
  * ```
87
109
  *
88
110
  * @param AdminCreateUserCommandInput - {@link AdminCreateUserCommandInput}
@@ -150,6 +172,8 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
150
172
  * @throws {@link UserNotFoundException} (client fault)
151
173
  * <p>This exception is thrown when a user isn't found.</p>
152
174
  *
175
+ * @throws {@link CognitoIdentityProviderServiceException}
176
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
153
177
  *
154
178
  */
155
179
  export declare class AdminCreateUserCommand extends $Command<AdminCreateUserCommandInput, AdminCreateUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
37
37
  * };
38
38
  * const command = new AdminDeleteUserAttributesCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param AdminDeleteUserAttributesCommandInput - {@link AdminDeleteUserAttributesCommandInput}
@@ -66,6 +68,8 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
66
68
  * @throws {@link UserNotFoundException} (client fault)
67
69
  * <p>This exception is thrown when a user isn't found.</p>
68
70
  *
71
+ * @throws {@link CognitoIdentityProviderServiceException}
72
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
69
73
  *
70
74
  */
71
75
  export declare class AdminDeleteUserAttributesCommand extends $Command<AdminDeleteUserAttributesCommandInput, AdminDeleteUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new AdminDeleteUserCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param AdminDeleteUserCommandInput - {@link AdminDeleteUserCommandInput}
@@ -62,6 +64,8 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {
62
64
  * @throws {@link UserNotFoundException} (client fault)
63
65
  * <p>This exception is thrown when a user isn't found.</p>
64
66
  *
67
+ * @throws {@link CognitoIdentityProviderServiceException}
68
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
65
69
  *
66
70
  */
67
71
  export declare class AdminDeleteUserCommand extends $Command<AdminDeleteUserCommandInput, AdminDeleteUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -63,6 +63,8 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
63
63
  * };
64
64
  * const command = new AdminDisableProviderForUserCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // {};
67
+ *
66
68
  * ```
67
69
  *
68
70
  * @param AdminDisableProviderForUserCommandInput - {@link AdminDisableProviderForUserCommandInput}
@@ -99,6 +101,8 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
99
101
  * @throws {@link UserNotFoundException} (client fault)
100
102
  * <p>This exception is thrown when a user isn't found.</p>
101
103
  *
104
+ * @throws {@link CognitoIdentityProviderServiceException}
105
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
102
106
  *
103
107
  */
104
108
  export declare class AdminDisableProviderForUserCommand extends $Command<AdminDisableProviderForUserCommandInput, AdminDisableProviderForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
34
34
  * };
35
35
  * const command = new AdminDisableUserCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param AdminDisableUserCommandInput - {@link AdminDisableUserCommandInput}
@@ -63,6 +65,8 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
63
65
  * @throws {@link UserNotFoundException} (client fault)
64
66
  * <p>This exception is thrown when a user isn't found.</p>
65
67
  *
68
+ * @throws {@link CognitoIdentityProviderServiceException}
69
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
66
70
  *
67
71
  */
68
72
  export declare class AdminDisableUserCommand extends $Command<AdminDisableUserCommandInput, AdminDisableUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
33
33
  * };
34
34
  * const command = new AdminEnableUserCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param AdminEnableUserCommandInput - {@link AdminEnableUserCommandInput}
@@ -62,6 +64,8 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
62
64
  * @throws {@link UserNotFoundException} (client fault)
63
65
  * <p>This exception is thrown when a user isn't found.</p>
64
66
  *
67
+ * @throws {@link CognitoIdentityProviderServiceException}
68
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
65
69
  *
66
70
  */
67
71
  export declare class AdminEnableUserCommand extends $Command<AdminEnableUserCommandInput, AdminEnableUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new AdminForgetDeviceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param AdminForgetDeviceCommandInput - {@link AdminForgetDeviceCommandInput}
@@ -66,6 +68,8 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {
66
68
  * @throws {@link UserNotFoundException} (client fault)
67
69
  * <p>This exception is thrown when a user isn't found.</p>
68
70
  *
71
+ * @throws {@link CognitoIdentityProviderServiceException}
72
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
69
73
  *
70
74
  */
71
75
  export declare class AdminForgetDeviceCommand extends $Command<AdminForgetDeviceCommandInput, AdminForgetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,21 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
34
34
  * };
35
35
  * const command = new AdminGetDeviceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // AdminGetDeviceResponse
38
+ * // Device: { // DeviceType
39
+ * // DeviceKey: "STRING_VALUE",
40
+ * // DeviceAttributes: [ // AttributeListType
41
+ * // { // AttributeType
42
+ * // Name: "STRING_VALUE", // required
43
+ * // Value: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // DeviceCreateDate: new Date("TIMESTAMP"),
47
+ * // DeviceLastModifiedDate: new Date("TIMESTAMP"),
48
+ * // DeviceLastAuthenticatedDate: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // };
51
+ *
37
52
  * ```
38
53
  *
39
54
  * @param AdminGetDeviceCommandInput - {@link AdminGetDeviceCommandInput}
@@ -63,6 +78,8 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
63
78
  * <p>This exception is thrown when the user has made too many requests for a given
64
79
  * operation.</p>
65
80
  *
81
+ * @throws {@link CognitoIdentityProviderServiceException}
82
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
66
83
  *
67
84
  */
68
85
  export declare class AdminGetDeviceCommand extends $Command<AdminGetDeviceCommandInput, AdminGetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,30 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
34
34
  * };
35
35
  * const command = new AdminGetUserCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // AdminGetUserResponse
38
+ * // Username: "STRING_VALUE", // required
39
+ * // UserAttributes: [ // AttributeListType
40
+ * // { // AttributeType
41
+ * // Name: "STRING_VALUE", // required
42
+ * // Value: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // UserCreateDate: new Date("TIMESTAMP"),
46
+ * // UserLastModifiedDate: new Date("TIMESTAMP"),
47
+ * // Enabled: true || false,
48
+ * // UserStatus: "UNCONFIRMED" || "CONFIRMED" || "ARCHIVED" || "COMPROMISED" || "UNKNOWN" || "RESET_REQUIRED" || "FORCE_CHANGE_PASSWORD",
49
+ * // MFAOptions: [ // MFAOptionListType
50
+ * // { // MFAOptionType
51
+ * // DeliveryMedium: "SMS" || "EMAIL",
52
+ * // AttributeName: "STRING_VALUE",
53
+ * // },
54
+ * // ],
55
+ * // PreferredMfaSetting: "STRING_VALUE",
56
+ * // UserMFASettingList: [ // UserMFASettingListType
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // };
60
+ *
37
61
  * ```
38
62
  *
39
63
  * @param AdminGetUserCommandInput - {@link AdminGetUserCommandInput}
@@ -63,6 +87,8 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
63
87
  * @throws {@link UserNotFoundException} (client fault)
64
88
  * <p>This exception is thrown when a user isn't found.</p>
65
89
  *
90
+ * @throws {@link CognitoIdentityProviderServiceException}
91
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
66
92
  *
67
93
  */
68
94
  export declare class AdminGetUserCommand extends $Command<AdminGetUserCommandInput, AdminGetUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -74,6 +74,25 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
74
74
  * };
75
75
  * const command = new AdminInitiateAuthCommand(input);
76
76
  * const response = await client.send(command);
77
+ * // { // AdminInitiateAuthResponse
78
+ * // ChallengeName: "SMS_MFA" || "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",
79
+ * // Session: "STRING_VALUE",
80
+ * // ChallengeParameters: { // ChallengeParametersType
81
+ * // "<keys>": "STRING_VALUE",
82
+ * // },
83
+ * // AuthenticationResult: { // AuthenticationResultType
84
+ * // AccessToken: "STRING_VALUE",
85
+ * // ExpiresIn: Number("int"),
86
+ * // TokenType: "STRING_VALUE",
87
+ * // RefreshToken: "STRING_VALUE",
88
+ * // IdToken: "STRING_VALUE",
89
+ * // NewDeviceMetadata: { // NewDeviceMetadataType
90
+ * // DeviceKey: "STRING_VALUE",
91
+ * // DeviceGroupKey: "STRING_VALUE",
92
+ * // },
93
+ * // },
94
+ * // };
95
+ *
77
96
  * ```
78
97
  *
79
98
  * @param AdminInitiateAuthCommandInput - {@link AdminInitiateAuthCommandInput}
@@ -137,6 +156,8 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
137
156
  * @throws {@link UserNotFoundException} (client fault)
138
157
  * <p>This exception is thrown when a user isn't found.</p>
139
158
  *
159
+ * @throws {@link CognitoIdentityProviderServiceException}
160
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
140
161
  *
141
162
  */
142
163
  export declare class AdminInitiateAuthCommand extends $Command<AdminInitiateAuthCommandInput, AdminInitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -59,6 +59,8 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
59
59
  * };
60
60
  * const command = new AdminLinkProviderForUserCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // {};
63
+ *
62
64
  * ```
63
65
  *
64
66
  * @param AdminLinkProviderForUserCommandInput - {@link AdminLinkProviderForUserCommandInput}
@@ -99,6 +101,8 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
99
101
  * @throws {@link UserNotFoundException} (client fault)
100
102
  * <p>This exception is thrown when a user isn't found.</p>
101
103
  *
104
+ * @throws {@link CognitoIdentityProviderServiceException}
105
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
102
106
  *
103
107
  */
104
108
  export declare class AdminLinkProviderForUserCommand extends $Command<AdminLinkProviderForUserCommandInput, AdminLinkProviderForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,24 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
35
35
  * };
36
36
  * const command = new AdminListDevicesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // AdminListDevicesResponse
39
+ * // Devices: [ // DeviceListType
40
+ * // { // DeviceType
41
+ * // DeviceKey: "STRING_VALUE",
42
+ * // DeviceAttributes: [ // AttributeListType
43
+ * // { // AttributeType
44
+ * // Name: "STRING_VALUE", // required
45
+ * // Value: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // DeviceCreateDate: new Date("TIMESTAMP"),
49
+ * // DeviceLastModifiedDate: new Date("TIMESTAMP"),
50
+ * // DeviceLastAuthenticatedDate: new Date("TIMESTAMP"),
51
+ * // },
52
+ * // ],
53
+ * // PaginationToken: "STRING_VALUE",
54
+ * // };
55
+ *
38
56
  * ```
39
57
  *
40
58
  * @param AdminListDevicesCommandInput - {@link AdminListDevicesCommandInput}
@@ -64,6 +82,8 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
64
82
  * <p>This exception is thrown when the user has made too many requests for a given
65
83
  * operation.</p>
66
84
  *
85
+ * @throws {@link CognitoIdentityProviderServiceException}
86
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
67
87
  *
68
88
  */
69
89
  export declare class AdminListDevicesCommand extends $Command<AdminListDevicesCommandInput, AdminListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,21 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
35
35
  * };
36
36
  * const command = new AdminListGroupsForUserCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // AdminListGroupsForUserResponse
39
+ * // Groups: [ // GroupListType
40
+ * // { // GroupType
41
+ * // GroupName: "STRING_VALUE",
42
+ * // UserPoolId: "STRING_VALUE",
43
+ * // Description: "STRING_VALUE",
44
+ * // RoleArn: "STRING_VALUE",
45
+ * // Precedence: Number("int"),
46
+ * // LastModifiedDate: new Date("TIMESTAMP"),
47
+ * // CreationDate: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // ],
50
+ * // NextToken: "STRING_VALUE",
51
+ * // };
52
+ *
38
53
  * ```
39
54
  *
40
55
  * @param AdminListGroupsForUserCommandInput - {@link AdminListGroupsForUserCommandInput}
@@ -64,6 +79,8 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
64
79
  * @throws {@link UserNotFoundException} (client fault)
65
80
  * <p>This exception is thrown when a user isn't found.</p>
66
81
  *
82
+ * @throws {@link CognitoIdentityProviderServiceException}
83
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
67
84
  *
68
85
  */
69
86
  export declare class AdminListGroupsForUserCommand extends $Command<AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,41 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
35
35
  * };
36
36
  * const command = new AdminListUserAuthEventsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // AdminListUserAuthEventsResponse
39
+ * // AuthEvents: [ // AuthEventsType
40
+ * // { // AuthEventType
41
+ * // EventId: "STRING_VALUE",
42
+ * // EventType: "SignIn" || "SignUp" || "ForgotPassword" || "PasswordChange" || "ResendCode",
43
+ * // CreationDate: new Date("TIMESTAMP"),
44
+ * // EventResponse: "Pass" || "Fail" || "InProgress",
45
+ * // EventRisk: { // EventRiskType
46
+ * // RiskDecision: "NoRisk" || "AccountTakeover" || "Block",
47
+ * // RiskLevel: "Low" || "Medium" || "High",
48
+ * // CompromisedCredentialsDetected: true || false,
49
+ * // },
50
+ * // ChallengeResponses: [ // ChallengeResponseListType
51
+ * // { // ChallengeResponseType
52
+ * // ChallengeName: "Password" || "Mfa",
53
+ * // ChallengeResponse: "Success" || "Failure",
54
+ * // },
55
+ * // ],
56
+ * // EventContextData: { // EventContextDataType
57
+ * // IpAddress: "STRING_VALUE",
58
+ * // DeviceName: "STRING_VALUE",
59
+ * // Timezone: "STRING_VALUE",
60
+ * // City: "STRING_VALUE",
61
+ * // Country: "STRING_VALUE",
62
+ * // },
63
+ * // EventFeedback: { // EventFeedbackType
64
+ * // FeedbackValue: "Valid" || "Invalid", // required
65
+ * // Provider: "STRING_VALUE", // required
66
+ * // FeedbackDate: new Date("TIMESTAMP"),
67
+ * // },
68
+ * // },
69
+ * // ],
70
+ * // NextToken: "STRING_VALUE",
71
+ * // };
72
+ *
38
73
  * ```
39
74
  *
40
75
  * @param AdminListUserAuthEventsCommandInput - {@link AdminListUserAuthEventsCommandInput}
@@ -67,6 +102,8 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
67
102
  * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
68
103
  * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
69
104
  *
105
+ * @throws {@link CognitoIdentityProviderServiceException}
106
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
70
107
  *
71
108
  */
72
109
  export declare class AdminListUserAuthEventsCommand extends $Command<AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
34
34
  * };
35
35
  * const command = new AdminRemoveUserFromGroupCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param AdminRemoveUserFromGroupCommandInput - {@link AdminRemoveUserFromGroupCommandInput}
@@ -63,6 +65,8 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
63
65
  * @throws {@link UserNotFoundException} (client fault)
64
66
  * <p>This exception is thrown when a user isn't found.</p>
65
67
  *
68
+ * @throws {@link CognitoIdentityProviderServiceException}
69
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
66
70
  *
67
71
  */
68
72
  export declare class AdminRemoveUserFromGroupCommand extends $Command<AdminRemoveUserFromGroupCommandInput, AdminRemoveUserFromGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -64,6 +64,8 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
64
64
  * };
65
65
  * const command = new AdminResetUserPasswordCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // {};
68
+ *
67
69
  * ```
68
70
  *
69
71
  * @param AdminResetUserPasswordCommandInput - {@link AdminResetUserPasswordCommandInput}
@@ -122,6 +124,8 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
122
124
  * @throws {@link UserNotFoundException} (client fault)
123
125
  * <p>This exception is thrown when a user isn't found.</p>
124
126
  *
127
+ * @throws {@link CognitoIdentityProviderServiceException}
128
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
125
129
  *
126
130
  */
127
131
  export declare class AdminResetUserPasswordCommand extends $Command<AdminResetUserPasswordCommandInput, AdminResetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -75,6 +75,25 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
75
75
  * };
76
76
  * const command = new AdminRespondToAuthChallengeCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // AdminRespondToAuthChallengeResponse
79
+ * // ChallengeName: "SMS_MFA" || "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",
80
+ * // Session: "STRING_VALUE",
81
+ * // ChallengeParameters: { // ChallengeParametersType
82
+ * // "<keys>": "STRING_VALUE",
83
+ * // },
84
+ * // AuthenticationResult: { // AuthenticationResultType
85
+ * // AccessToken: "STRING_VALUE",
86
+ * // ExpiresIn: Number("int"),
87
+ * // TokenType: "STRING_VALUE",
88
+ * // RefreshToken: "STRING_VALUE",
89
+ * // IdToken: "STRING_VALUE",
90
+ * // NewDeviceMetadata: { // NewDeviceMetadataType
91
+ * // DeviceKey: "STRING_VALUE",
92
+ * // DeviceGroupKey: "STRING_VALUE",
93
+ * // },
94
+ * // },
95
+ * // };
96
+ *
78
97
  * ```
79
98
  *
80
99
  * @param AdminRespondToAuthChallengeCommandInput - {@link AdminRespondToAuthChallengeCommandInput}
@@ -159,6 +178,8 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
159
178
  * @throws {@link UserNotFoundException} (client fault)
160
179
  * <p>This exception is thrown when a user isn't found.</p>
161
180
  *
181
+ * @throws {@link CognitoIdentityProviderServiceException}
182
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
162
183
  *
163
184
  */
164
185
  export declare class AdminRespondToAuthChallengeCommand extends $Command<AdminRespondToAuthChallengeCommandInput, AdminRespondToAuthChallengeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -44,6 +44,8 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
44
44
  * };
45
45
  * const command = new AdminSetUserMFAPreferenceCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // {};
48
+ *
47
49
  * ```
48
50
  *
49
51
  * @param AdminSetUserMFAPreferenceCommandInput - {@link AdminSetUserMFAPreferenceCommandInput}
@@ -75,6 +77,8 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
75
77
  * @throws {@link UserNotFoundException} (client fault)
76
78
  * <p>This exception is thrown when a user isn't found.</p>
77
79
  *
80
+ * @throws {@link CognitoIdentityProviderServiceException}
81
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
78
82
  *
79
83
  */
80
84
  export declare class AdminSetUserMFAPreferenceCommand extends $Command<AdminSetUserMFAPreferenceCommandInput, AdminSetUserMFAPreferenceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -43,6 +43,8 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
43
43
  * };
44
44
  * const command = new AdminSetUserPasswordCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // {};
47
+ *
46
48
  * ```
47
49
  *
48
50
  * @param AdminSetUserPasswordCommandInput - {@link AdminSetUserPasswordCommandInput}
@@ -75,6 +77,8 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
75
77
  * @throws {@link UserNotFoundException} (client fault)
76
78
  * <p>This exception is thrown when a user isn't found.</p>
77
79
  *
80
+ * @throws {@link CognitoIdentityProviderServiceException}
81
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
78
82
  *
79
83
  */
80
84
  export declare class AdminSetUserPasswordCommand extends $Command<AdminSetUserPasswordCommandInput, AdminSetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
41
41
  * };
42
42
  * const command = new AdminSetUserSettingsCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param AdminSetUserSettingsCommandInput - {@link AdminSetUserSettingsCommandInput}
@@ -66,6 +68,8 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
66
68
  * @throws {@link UserNotFoundException} (client fault)
67
69
  * <p>This exception is thrown when a user isn't found.</p>
68
70
  *
71
+ * @throws {@link CognitoIdentityProviderServiceException}
72
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
69
73
  *
70
74
  */
71
75
  export declare class AdminSetUserSettingsCommand extends $Command<AdminSetUserSettingsCommandInput, AdminSetUserSettingsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
36
36
  * };
37
37
  * const command = new AdminUpdateAuthEventFeedbackCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param AdminUpdateAuthEventFeedbackCommandInput - {@link AdminUpdateAuthEventFeedbackCommandInput}
@@ -68,6 +70,8 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
68
70
  * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
69
71
  * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
70
72
  *
73
+ * @throws {@link CognitoIdentityProviderServiceException}
74
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
71
75
  *
72
76
  */
73
77
  export declare class AdminUpdateAuthEventFeedbackCommand extends $Command<AdminUpdateAuthEventFeedbackCommandInput, AdminUpdateAuthEventFeedbackCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
35
35
  * };
36
36
  * const command = new AdminUpdateDeviceStatusCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param AdminUpdateDeviceStatusCommandInput - {@link AdminUpdateDeviceStatusCommandInput}
@@ -67,6 +69,8 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
67
69
  * @throws {@link UserNotFoundException} (client fault)
68
70
  * <p>This exception is thrown when a user isn't found.</p>
69
71
  *
72
+ * @throws {@link CognitoIdentityProviderServiceException}
73
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
70
74
  *
71
75
  */
72
76
  export declare class AdminUpdateDeviceStatusCommand extends $Command<AdminUpdateDeviceStatusCommandInput, AdminUpdateDeviceStatusCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -66,6 +66,8 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
66
66
  * };
67
67
  * const command = new AdminUpdateUserAttributesCommand(input);
68
68
  * const response = await client.send(command);
69
+ * // {};
70
+ *
69
71
  * ```
70
72
  *
71
73
  * @param AdminUpdateUserAttributesCommandInput - {@link AdminUpdateUserAttributesCommandInput}
@@ -127,6 +129,8 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
127
129
  * @throws {@link UserNotFoundException} (client fault)
128
130
  * <p>This exception is thrown when a user isn't found.</p>
129
131
  *
132
+ * @throws {@link CognitoIdentityProviderServiceException}
133
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
130
134
  *
131
135
  */
132
136
  export declare class AdminUpdateUserAttributesCommand extends $Command<AdminUpdateUserAttributesCommandInput, AdminUpdateUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {