@aws-sdk/client-cognito-identity-provider 3.289.0 → 3.292.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 +23 -0
  2. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +22 -0
  3. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +41 -0
  4. package/dist-types/commands/AdminCreateUserCommand.d.ts +60 -0
  5. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +22 -0
  6. package/dist-types/commands/AdminDeleteUserCommand.d.ts +22 -0
  7. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +29 -0
  8. package/dist-types/commands/AdminDisableUserCommand.d.ts +22 -0
  9. package/dist-types/commands/AdminEnableUserCommand.d.ts +22 -0
  10. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +25 -0
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +22 -0
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +22 -0
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +56 -0
  14. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +33 -0
  15. package/dist-types/commands/AdminListDevicesCommand.d.ts +22 -0
  16. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +22 -0
  17. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +25 -0
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +22 -0
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +51 -0
  20. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +77 -0
  21. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +24 -0
  22. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +25 -0
  23. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +18 -0
  24. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +25 -0
  25. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +25 -0
  26. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +54 -0
  27. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +22 -0
  28. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +26 -0
  29. package/dist-types/commands/ChangePasswordCommand.d.ts +38 -0
  30. package/dist-types/commands/ConfirmDeviceCommand.d.ts +44 -0
  31. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +57 -0
  32. package/dist-types/commands/ConfirmSignUpCommand.d.ts +58 -0
  33. package/dist-types/commands/CreateGroupCommand.d.ts +27 -0
  34. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +27 -0
  35. package/dist-types/commands/CreateResourceServerCommand.d.ts +23 -0
  36. package/dist-types/commands/CreateUserImportJobCommand.d.ts +26 -0
  37. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +29 -0
  38. package/dist-types/commands/CreateUserPoolCommand.d.ts +36 -0
  39. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +19 -0
  40. package/dist-types/commands/DeleteGroupCommand.d.ts +19 -0
  41. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +26 -0
  42. package/dist-types/commands/DeleteResourceServerCommand.d.ts +19 -0
  43. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +31 -0
  44. package/dist-types/commands/DeleteUserCommand.d.ts +31 -0
  45. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +23 -0
  46. package/dist-types/commands/DeleteUserPoolCommand.d.ts +23 -0
  47. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +15 -0
  48. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +19 -0
  49. package/dist-types/commands/DescribeResourceServerCommand.d.ts +19 -0
  50. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +22 -0
  51. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +19 -0
  52. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +19 -0
  53. package/dist-types/commands/DescribeUserPoolCommand.d.ts +22 -0
  54. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +15 -0
  55. package/dist-types/commands/ForgetDeviceCommand.d.ts +34 -0
  56. package/dist-types/commands/ForgotPasswordCommand.d.ts +58 -0
  57. package/dist-types/commands/GetCSVHeaderCommand.d.ts +19 -0
  58. package/dist-types/commands/GetDeviceCommand.d.ts +34 -0
  59. package/dist-types/commands/GetGroupCommand.d.ts +19 -0
  60. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +19 -0
  61. package/dist-types/commands/GetSigningCertificateCommand.d.ts +12 -0
  62. package/dist-types/commands/GetUICustomizationCommand.d.ts +19 -0
  63. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +64 -0
  64. package/dist-types/commands/GetUserCommand.d.ts +31 -0
  65. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +19 -0
  66. package/dist-types/commands/GlobalSignOutCommand.d.ts +28 -0
  67. package/dist-types/commands/InitiateAuthCommand.d.ts +55 -0
  68. package/dist-types/commands/ListDevicesCommand.d.ts +34 -0
  69. package/dist-types/commands/ListGroupsCommand.d.ts +19 -0
  70. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +19 -0
  71. package/dist-types/commands/ListResourceServersCommand.d.ts +19 -0
  72. package/dist-types/commands/ListTagsForResourceCommand.d.ts +19 -0
  73. package/dist-types/commands/ListUserImportJobsCommand.d.ts +19 -0
  74. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +19 -0
  75. package/dist-types/commands/ListUserPoolsCommand.d.ts +15 -0
  76. package/dist-types/commands/ListUsersCommand.d.ts +19 -0
  77. package/dist-types/commands/ListUsersInGroupCommand.d.ts +19 -0
  78. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +58 -0
  79. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +80 -0
  80. package/dist-types/commands/RevokeTokenCommand.d.ts +26 -0
  81. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +30 -0
  82. package/dist-types/commands/SetUICustomizationCommand.d.ts +19 -0
  83. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +27 -0
  84. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +29 -0
  85. package/dist-types/commands/SetUserSettingsCommand.d.ts +27 -0
  86. package/dist-types/commands/SignUpCommand.d.ts +58 -0
  87. package/dist-types/commands/StartUserImportJobCommand.d.ts +22 -0
  88. package/dist-types/commands/StopUserImportJobCommand.d.ts +22 -0
  89. package/dist-types/commands/TagResourceCommand.d.ts +19 -0
  90. package/dist-types/commands/UntagResourceCommand.d.ts +19 -0
  91. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +25 -0
  92. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +34 -0
  93. package/dist-types/commands/UpdateGroupCommand.d.ts +19 -0
  94. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +26 -0
  95. package/dist-types/commands/UpdateResourceServerCommand.d.ts +19 -0
  96. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +74 -0
  97. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +29 -0
  98. package/dist-types/commands/UpdateUserPoolCommand.d.ts +44 -0
  99. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +19 -0
  100. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +46 -0
  101. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +49 -0
  102. package/package.json +35 -40
@@ -58,6 +58,57 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
58
58
  * @see {@link AdminResetUserPasswordCommandOutput} for command's `response` shape.
59
59
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
60
60
  *
61
+ * @throws {@link InternalErrorException} (server fault)
62
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
63
+ *
64
+ * @throws {@link InvalidEmailRoleAccessPolicyException} (client fault)
65
+ * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
66
+ * status code: 400.</p>
67
+ *
68
+ * @throws {@link InvalidLambdaResponseException} (client fault)
69
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
70
+ *
71
+ * @throws {@link InvalidParameterException} (client fault)
72
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
73
+ * parameter.</p>
74
+ *
75
+ * @throws {@link InvalidSmsRoleAccessPolicyException} (client fault)
76
+ * <p>This exception is returned when the role provided for SMS configuration doesn't have
77
+ * permission to publish using Amazon SNS.</p>
78
+ *
79
+ * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
80
+ * <p>This exception is thrown when the trust relationship is not valid for the role
81
+ * provided for SMS configuration. This can happen if you don't trust
82
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
83
+ * not match what is provided in the SMS configuration for the user pool.</p>
84
+ *
85
+ * @throws {@link LimitExceededException} (client fault)
86
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
87
+ * resource.</p>
88
+ *
89
+ * @throws {@link NotAuthorizedException} (client fault)
90
+ * <p>This exception is thrown when a user isn't authorized.</p>
91
+ *
92
+ * @throws {@link ResourceNotFoundException} (client fault)
93
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
94
+ * resource.</p>
95
+ *
96
+ * @throws {@link TooManyRequestsException} (client fault)
97
+ * <p>This exception is thrown when the user has made too many requests for a given
98
+ * operation.</p>
99
+ *
100
+ * @throws {@link UnexpectedLambdaException} (client fault)
101
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
102
+ * Lambda.</p>
103
+ *
104
+ * @throws {@link UserLambdaValidationException} (client fault)
105
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
106
+ * with the Lambda service.</p>
107
+ *
108
+ * @throws {@link UserNotFoundException} (client fault)
109
+ * <p>This exception is thrown when a user isn't found.</p>
110
+ *
111
+ *
61
112
  */
62
113
  export declare class AdminResetUserPasswordCommand extends $Command<AdminResetUserPasswordCommandInput, AdminResetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
63
114
  readonly input: AdminResetUserPasswordCommandInput;
@@ -49,6 +49,83 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
49
49
  * @see {@link AdminRespondToAuthChallengeCommandOutput} for command's `response` shape.
50
50
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
51
51
  *
52
+ * @throws {@link AliasExistsException} (client fault)
53
+ * <p>This exception is thrown when a user tries to confirm the account with an email
54
+ * address or phone number that has already been supplied as an alias for a different
55
+ * user profile. This exception indicates that an account with this email address or phone
56
+ * already exists in a user pool that you've configured to use email address or phone
57
+ * number as a sign-in alias.</p>
58
+ *
59
+ * @throws {@link CodeMismatchException} (client fault)
60
+ * <p>This exception is thrown if the provided code doesn't match what the server was
61
+ * expecting.</p>
62
+ *
63
+ * @throws {@link ExpiredCodeException} (client fault)
64
+ * <p>This exception is thrown if a code has expired.</p>
65
+ *
66
+ * @throws {@link InternalErrorException} (server fault)
67
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
68
+ *
69
+ * @throws {@link InvalidLambdaResponseException} (client fault)
70
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
71
+ *
72
+ * @throws {@link InvalidParameterException} (client fault)
73
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
74
+ * parameter.</p>
75
+ *
76
+ * @throws {@link InvalidPasswordException} (client fault)
77
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
78
+ *
79
+ * @throws {@link InvalidSmsRoleAccessPolicyException} (client fault)
80
+ * <p>This exception is returned when the role provided for SMS configuration doesn't have
81
+ * permission to publish using Amazon SNS.</p>
82
+ *
83
+ * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
84
+ * <p>This exception is thrown when the trust relationship is not valid for the role
85
+ * provided for SMS configuration. This can happen if you don't trust
86
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
87
+ * not match what is provided in the SMS configuration for the user pool.</p>
88
+ *
89
+ * @throws {@link InvalidUserPoolConfigurationException} (client fault)
90
+ * <p>This exception is thrown when the user pool configuration is not valid.</p>
91
+ *
92
+ * @throws {@link MFAMethodNotFoundException} (client fault)
93
+ * <p>This exception is thrown when Amazon Cognito can't find a multi-factor authentication
94
+ * (MFA) method.</p>
95
+ *
96
+ * @throws {@link NotAuthorizedException} (client fault)
97
+ * <p>This exception is thrown when a user isn't authorized.</p>
98
+ *
99
+ * @throws {@link PasswordResetRequiredException} (client fault)
100
+ * <p>This exception is thrown when a password reset is required.</p>
101
+ *
102
+ * @throws {@link ResourceNotFoundException} (client fault)
103
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
104
+ * resource.</p>
105
+ *
106
+ * @throws {@link SoftwareTokenMFANotFoundException} (client fault)
107
+ * <p>This exception is thrown when the software token time-based one-time password (TOTP)
108
+ * multi-factor authentication (MFA) isn't activated for the user pool.</p>
109
+ *
110
+ * @throws {@link TooManyRequestsException} (client fault)
111
+ * <p>This exception is thrown when the user has made too many requests for a given
112
+ * operation.</p>
113
+ *
114
+ * @throws {@link UnexpectedLambdaException} (client fault)
115
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
116
+ * Lambda.</p>
117
+ *
118
+ * @throws {@link UserLambdaValidationException} (client fault)
119
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
120
+ * with the Lambda service.</p>
121
+ *
122
+ * @throws {@link UserNotConfirmedException} (client fault)
123
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
124
+ *
125
+ * @throws {@link UserNotFoundException} (client fault)
126
+ * <p>This exception is thrown when a user isn't found.</p>
127
+ *
128
+ *
52
129
  */
53
130
  export declare class AdminRespondToAuthChallengeCommand extends $Command<AdminRespondToAuthChallengeCommandInput, AdminRespondToAuthChallengeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
54
131
  readonly input: AdminRespondToAuthChallengeCommandInput;
@@ -33,6 +33,30 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
33
33
  * @see {@link AdminSetUserMFAPreferenceCommandOutput} for command's `response` shape.
34
34
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
35
35
  *
36
+ * @throws {@link InternalErrorException} (server fault)
37
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
38
+ *
39
+ * @throws {@link InvalidParameterException} (client fault)
40
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
41
+ * parameter.</p>
42
+ *
43
+ * @throws {@link NotAuthorizedException} (client fault)
44
+ * <p>This exception is thrown when a user isn't authorized.</p>
45
+ *
46
+ * @throws {@link PasswordResetRequiredException} (client fault)
47
+ * <p>This exception is thrown when a password reset is required.</p>
48
+ *
49
+ * @throws {@link ResourceNotFoundException} (client fault)
50
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
51
+ * resource.</p>
52
+ *
53
+ * @throws {@link UserNotConfirmedException} (client fault)
54
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
55
+ *
56
+ * @throws {@link UserNotFoundException} (client fault)
57
+ * <p>This exception is thrown when a user isn't found.</p>
58
+ *
59
+ *
36
60
  */
37
61
  export declare class AdminSetUserMFAPreferenceCommand extends $Command<AdminSetUserMFAPreferenceCommandInput, AdminSetUserMFAPreferenceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
38
62
  readonly input: AdminSetUserMFAPreferenceCommandInput;
@@ -38,6 +38,31 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
38
38
  * @see {@link AdminSetUserPasswordCommandOutput} for command's `response` shape.
39
39
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
40
40
  *
41
+ * @throws {@link InternalErrorException} (server fault)
42
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
43
+ *
44
+ * @throws {@link InvalidParameterException} (client fault)
45
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
46
+ * parameter.</p>
47
+ *
48
+ * @throws {@link InvalidPasswordException} (client fault)
49
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
50
+ *
51
+ * @throws {@link NotAuthorizedException} (client fault)
52
+ * <p>This exception is thrown when a user isn't authorized.</p>
53
+ *
54
+ * @throws {@link ResourceNotFoundException} (client fault)
55
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
56
+ * resource.</p>
57
+ *
58
+ * @throws {@link TooManyRequestsException} (client fault)
59
+ * <p>This exception is thrown when the user has made too many requests for a given
60
+ * operation.</p>
61
+ *
62
+ * @throws {@link UserNotFoundException} (client fault)
63
+ * <p>This exception is thrown when a user isn't found.</p>
64
+ *
65
+ *
41
66
  */
42
67
  export declare class AdminSetUserPasswordCommand extends $Command<AdminSetUserPasswordCommandInput, AdminSetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
43
68
  readonly input: AdminSetUserPasswordCommandInput;
@@ -32,6 +32,24 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
32
32
  * @see {@link AdminSetUserSettingsCommandOutput} for command's `response` shape.
33
33
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
34
34
  *
35
+ * @throws {@link InternalErrorException} (server fault)
36
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
37
+ *
38
+ * @throws {@link InvalidParameterException} (client fault)
39
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
40
+ * parameter.</p>
41
+ *
42
+ * @throws {@link NotAuthorizedException} (client fault)
43
+ * <p>This exception is thrown when a user isn't authorized.</p>
44
+ *
45
+ * @throws {@link ResourceNotFoundException} (client fault)
46
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
47
+ * resource.</p>
48
+ *
49
+ * @throws {@link UserNotFoundException} (client fault)
50
+ * <p>This exception is thrown when a user isn't found.</p>
51
+ *
52
+ *
35
53
  */
36
54
  export declare class AdminSetUserSettingsCommand extends $Command<AdminSetUserSettingsCommandInput, AdminSetUserSettingsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
37
55
  readonly input: AdminSetUserSettingsCommandInput;
@@ -31,6 +31,31 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
31
31
  * @see {@link AdminUpdateAuthEventFeedbackCommandOutput} for command's `response` shape.
32
32
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
33
33
  *
34
+ * @throws {@link InternalErrorException} (server fault)
35
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
36
+ *
37
+ * @throws {@link InvalidParameterException} (client fault)
38
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
39
+ * parameter.</p>
40
+ *
41
+ * @throws {@link NotAuthorizedException} (client fault)
42
+ * <p>This exception is thrown when a user isn't authorized.</p>
43
+ *
44
+ * @throws {@link ResourceNotFoundException} (client fault)
45
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
46
+ * resource.</p>
47
+ *
48
+ * @throws {@link TooManyRequestsException} (client fault)
49
+ * <p>This exception is thrown when the user has made too many requests for a given
50
+ * operation.</p>
51
+ *
52
+ * @throws {@link UserNotFoundException} (client fault)
53
+ * <p>This exception is thrown when a user isn't found.</p>
54
+ *
55
+ * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
56
+ * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
57
+ *
58
+ *
34
59
  */
35
60
  export declare class AdminUpdateAuthEventFeedbackCommand extends $Command<AdminUpdateAuthEventFeedbackCommandInput, AdminUpdateAuthEventFeedbackCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
61
  readonly input: AdminUpdateAuthEventFeedbackCommandInput;
@@ -30,6 +30,31 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
30
30
  * @see {@link AdminUpdateDeviceStatusCommandOutput} for command's `response` shape.
31
31
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalErrorException} (server fault)
34
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
35
+ *
36
+ * @throws {@link InvalidParameterException} (client fault)
37
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
38
+ * parameter.</p>
39
+ *
40
+ * @throws {@link InvalidUserPoolConfigurationException} (client fault)
41
+ * <p>This exception is thrown when the user pool configuration is not valid.</p>
42
+ *
43
+ * @throws {@link NotAuthorizedException} (client fault)
44
+ * <p>This exception is thrown when a user isn't authorized.</p>
45
+ *
46
+ * @throws {@link ResourceNotFoundException} (client fault)
47
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
48
+ * resource.</p>
49
+ *
50
+ * @throws {@link TooManyRequestsException} (client fault)
51
+ * <p>This exception is thrown when the user has made too many requests for a given
52
+ * operation.</p>
53
+ *
54
+ * @throws {@link UserNotFoundException} (client fault)
55
+ * <p>This exception is thrown when a user isn't found.</p>
56
+ *
57
+ *
33
58
  */
34
59
  export declare class AdminUpdateDeviceStatusCommand extends $Command<AdminUpdateDeviceStatusCommandInput, AdminUpdateDeviceStatusCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
60
  readonly input: AdminUpdateDeviceStatusCommandInput;
@@ -54,6 +54,60 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
54
54
  * @see {@link AdminUpdateUserAttributesCommandOutput} for command's `response` shape.
55
55
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
56
56
  *
57
+ * @throws {@link AliasExistsException} (client fault)
58
+ * <p>This exception is thrown when a user tries to confirm the account with an email
59
+ * address or phone number that has already been supplied as an alias for a different
60
+ * user profile. This exception indicates that an account with this email address or phone
61
+ * already exists in a user pool that you've configured to use email address or phone
62
+ * number as a sign-in alias.</p>
63
+ *
64
+ * @throws {@link InternalErrorException} (server fault)
65
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
66
+ *
67
+ * @throws {@link InvalidEmailRoleAccessPolicyException} (client fault)
68
+ * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
69
+ * status code: 400.</p>
70
+ *
71
+ * @throws {@link InvalidLambdaResponseException} (client fault)
72
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
73
+ *
74
+ * @throws {@link InvalidParameterException} (client fault)
75
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
76
+ * parameter.</p>
77
+ *
78
+ * @throws {@link InvalidSmsRoleAccessPolicyException} (client fault)
79
+ * <p>This exception is returned when the role provided for SMS configuration doesn't have
80
+ * permission to publish using Amazon SNS.</p>
81
+ *
82
+ * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
83
+ * <p>This exception is thrown when the trust relationship is not valid for the role
84
+ * provided for SMS configuration. This can happen if you don't trust
85
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
86
+ * not match what is provided in the SMS configuration for the user pool.</p>
87
+ *
88
+ * @throws {@link NotAuthorizedException} (client fault)
89
+ * <p>This exception is thrown when a user isn't authorized.</p>
90
+ *
91
+ * @throws {@link ResourceNotFoundException} (client fault)
92
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
93
+ * resource.</p>
94
+ *
95
+ * @throws {@link TooManyRequestsException} (client fault)
96
+ * <p>This exception is thrown when the user has made too many requests for a given
97
+ * operation.</p>
98
+ *
99
+ * @throws {@link UnexpectedLambdaException} (client fault)
100
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
101
+ * Lambda.</p>
102
+ *
103
+ * @throws {@link UserLambdaValidationException} (client fault)
104
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
105
+ * with the Lambda service.</p>
106
+ *
107
+ * @throws {@link UserNotFoundException} (client fault)
108
+ * <p>This exception is thrown when a user isn't found.</p>
109
+ *
110
+ *
57
111
  */
58
112
  export declare class AdminUpdateUserAttributesCommand extends $Command<AdminUpdateUserAttributesCommandInput, AdminUpdateUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
59
113
  readonly input: AdminUpdateUserAttributesCommandInput;
@@ -35,6 +35,28 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
35
35
  * @see {@link AdminUserGlobalSignOutCommandOutput} for command's `response` shape.
36
36
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
37
37
  *
38
+ * @throws {@link InternalErrorException} (server fault)
39
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
40
+ *
41
+ * @throws {@link InvalidParameterException} (client fault)
42
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
43
+ * parameter.</p>
44
+ *
45
+ * @throws {@link NotAuthorizedException} (client fault)
46
+ * <p>This exception is thrown when a user isn't authorized.</p>
47
+ *
48
+ * @throws {@link ResourceNotFoundException} (client fault)
49
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
50
+ * resource.</p>
51
+ *
52
+ * @throws {@link TooManyRequestsException} (client fault)
53
+ * <p>This exception is thrown when the user has made too many requests for a given
54
+ * operation.</p>
55
+ *
56
+ * @throws {@link UserNotFoundException} (client fault)
57
+ * <p>This exception is thrown when a user isn't found.</p>
58
+ *
59
+ *
38
60
  */
39
61
  export declare class AdminUserGlobalSignOutCommand extends $Command<AdminUserGlobalSignOutCommandInput, AdminUserGlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
40
62
  readonly input: AdminUserGlobalSignOutCommandInput;
@@ -45,6 +45,32 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
45
45
  * @see {@link AssociateSoftwareTokenCommandOutput} for command's `response` shape.
46
46
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
47
47
  *
48
+ * @throws {@link ConcurrentModificationException} (client fault)
49
+ * <p>This exception is thrown if two or more modifications are happening
50
+ * concurrently.</p>
51
+ *
52
+ * @throws {@link ForbiddenException} (client fault)
53
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
54
+ *
55
+ * @throws {@link InternalErrorException} (server fault)
56
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
57
+ *
58
+ * @throws {@link InvalidParameterException} (client fault)
59
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
60
+ * parameter.</p>
61
+ *
62
+ * @throws {@link NotAuthorizedException} (client fault)
63
+ * <p>This exception is thrown when a user isn't authorized.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
67
+ * resource.</p>
68
+ *
69
+ * @throws {@link SoftwareTokenMFANotFoundException} (client fault)
70
+ * <p>This exception is thrown when the software token time-based one-time password (TOTP)
71
+ * multi-factor authentication (MFA) isn't activated for the user pool.</p>
72
+ *
73
+ *
48
74
  */
49
75
  export declare class AssociateSoftwareTokenCommand extends $Command<AssociateSoftwareTokenCommandInput, AssociateSoftwareTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
50
76
  readonly input: AssociateSoftwareTokenCommandInput;
@@ -29,6 +29,44 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
29
29
  * @see {@link ChangePasswordCommandOutput} for command's `response` shape.
30
30
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
31
31
  *
32
+ * @throws {@link ForbiddenException} (client fault)
33
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
34
+ *
35
+ * @throws {@link InternalErrorException} (server fault)
36
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
37
+ *
38
+ * @throws {@link InvalidParameterException} (client fault)
39
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
40
+ * parameter.</p>
41
+ *
42
+ * @throws {@link InvalidPasswordException} (client fault)
43
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
44
+ *
45
+ * @throws {@link LimitExceededException} (client fault)
46
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
47
+ * resource.</p>
48
+ *
49
+ * @throws {@link NotAuthorizedException} (client fault)
50
+ * <p>This exception is thrown when a user isn't authorized.</p>
51
+ *
52
+ * @throws {@link PasswordResetRequiredException} (client fault)
53
+ * <p>This exception is thrown when a password reset is required.</p>
54
+ *
55
+ * @throws {@link ResourceNotFoundException} (client fault)
56
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
57
+ * resource.</p>
58
+ *
59
+ * @throws {@link TooManyRequestsException} (client fault)
60
+ * <p>This exception is thrown when the user has made too many requests for a given
61
+ * operation.</p>
62
+ *
63
+ * @throws {@link UserNotConfirmedException} (client fault)
64
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
65
+ *
66
+ * @throws {@link UserNotFoundException} (client fault)
67
+ * <p>This exception is thrown when a user isn't found.</p>
68
+ *
69
+ *
32
70
  */
33
71
  export declare class ChangePasswordCommand extends $Command<ChangePasswordCommandInput, ChangePasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
72
  readonly input: ChangePasswordCommandInput;
@@ -30,6 +30,50 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
30
30
  * @see {@link ConfirmDeviceCommandOutput} for command's `response` shape.
31
31
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
32
32
  *
33
+ * @throws {@link ForbiddenException} (client fault)
34
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
35
+ *
36
+ * @throws {@link InternalErrorException} (server fault)
37
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
38
+ *
39
+ * @throws {@link InvalidLambdaResponseException} (client fault)
40
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
41
+ *
42
+ * @throws {@link InvalidParameterException} (client fault)
43
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
44
+ * parameter.</p>
45
+ *
46
+ * @throws {@link InvalidPasswordException} (client fault)
47
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
48
+ *
49
+ * @throws {@link InvalidUserPoolConfigurationException} (client fault)
50
+ * <p>This exception is thrown when the user pool configuration is not valid.</p>
51
+ *
52
+ * @throws {@link NotAuthorizedException} (client fault)
53
+ * <p>This exception is thrown when a user isn't authorized.</p>
54
+ *
55
+ * @throws {@link PasswordResetRequiredException} (client fault)
56
+ * <p>This exception is thrown when a password reset is required.</p>
57
+ *
58
+ * @throws {@link ResourceNotFoundException} (client fault)
59
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
60
+ * resource.</p>
61
+ *
62
+ * @throws {@link TooManyRequestsException} (client fault)
63
+ * <p>This exception is thrown when the user has made too many requests for a given
64
+ * operation.</p>
65
+ *
66
+ * @throws {@link UsernameExistsException} (client fault)
67
+ * <p>This exception is thrown when Amazon Cognito encounters a user name that already
68
+ * exists in the user pool.</p>
69
+ *
70
+ * @throws {@link UserNotConfirmedException} (client fault)
71
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
72
+ *
73
+ * @throws {@link UserNotFoundException} (client fault)
74
+ * <p>This exception is thrown when a user isn't found.</p>
75
+ *
76
+ *
33
77
  */
34
78
  export declare class ConfirmDeviceCommand extends $Command<ConfirmDeviceCommandInput, ConfirmDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
79
  readonly input: ConfirmDeviceCommandInput;
@@ -29,6 +29,63 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
29
29
  * @see {@link ConfirmForgotPasswordCommandOutput} for command's `response` shape.
30
30
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
31
31
  *
32
+ * @throws {@link CodeMismatchException} (client fault)
33
+ * <p>This exception is thrown if the provided code doesn't match what the server was
34
+ * expecting.</p>
35
+ *
36
+ * @throws {@link ExpiredCodeException} (client fault)
37
+ * <p>This exception is thrown if a code has expired.</p>
38
+ *
39
+ * @throws {@link ForbiddenException} (client fault)
40
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
41
+ *
42
+ * @throws {@link InternalErrorException} (server fault)
43
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
44
+ *
45
+ * @throws {@link InvalidLambdaResponseException} (client fault)
46
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
47
+ *
48
+ * @throws {@link InvalidParameterException} (client fault)
49
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
50
+ * parameter.</p>
51
+ *
52
+ * @throws {@link InvalidPasswordException} (client fault)
53
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
54
+ *
55
+ * @throws {@link LimitExceededException} (client fault)
56
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
57
+ * resource.</p>
58
+ *
59
+ * @throws {@link NotAuthorizedException} (client fault)
60
+ * <p>This exception is thrown when a user isn't authorized.</p>
61
+ *
62
+ * @throws {@link ResourceNotFoundException} (client fault)
63
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
64
+ * resource.</p>
65
+ *
66
+ * @throws {@link TooManyFailedAttemptsException} (client fault)
67
+ * <p>This exception is thrown when the user has made too many failed attempts for a given
68
+ * action, such as sign-in.</p>
69
+ *
70
+ * @throws {@link TooManyRequestsException} (client fault)
71
+ * <p>This exception is thrown when the user has made too many requests for a given
72
+ * operation.</p>
73
+ *
74
+ * @throws {@link UnexpectedLambdaException} (client fault)
75
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
76
+ * Lambda.</p>
77
+ *
78
+ * @throws {@link UserLambdaValidationException} (client fault)
79
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
80
+ * with the Lambda service.</p>
81
+ *
82
+ * @throws {@link UserNotConfirmedException} (client fault)
83
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
84
+ *
85
+ * @throws {@link UserNotFoundException} (client fault)
86
+ * <p>This exception is thrown when a user isn't found.</p>
87
+ *
88
+ *
32
89
  */
33
90
  export declare class ConfirmForgotPasswordCommand extends $Command<ConfirmForgotPasswordCommandInput, ConfirmForgotPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
91
  readonly input: ConfirmForgotPasswordCommandInput;
@@ -29,6 +29,64 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
29
29
  * @see {@link ConfirmSignUpCommandOutput} for command's `response` shape.
30
30
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
31
31
  *
32
+ * @throws {@link AliasExistsException} (client fault)
33
+ * <p>This exception is thrown when a user tries to confirm the account with an email
34
+ * address or phone number that has already been supplied as an alias for a different
35
+ * user profile. This exception indicates that an account with this email address or phone
36
+ * already exists in a user pool that you've configured to use email address or phone
37
+ * number as a sign-in alias.</p>
38
+ *
39
+ * @throws {@link CodeMismatchException} (client fault)
40
+ * <p>This exception is thrown if the provided code doesn't match what the server was
41
+ * expecting.</p>
42
+ *
43
+ * @throws {@link ExpiredCodeException} (client fault)
44
+ * <p>This exception is thrown if a code has expired.</p>
45
+ *
46
+ * @throws {@link ForbiddenException} (client fault)
47
+ * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
48
+ *
49
+ * @throws {@link InternalErrorException} (server fault)
50
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
51
+ *
52
+ * @throws {@link InvalidLambdaResponseException} (client fault)
53
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
54
+ *
55
+ * @throws {@link InvalidParameterException} (client fault)
56
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
57
+ * parameter.</p>
58
+ *
59
+ * @throws {@link LimitExceededException} (client fault)
60
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
61
+ * resource.</p>
62
+ *
63
+ * @throws {@link NotAuthorizedException} (client fault)
64
+ * <p>This exception is thrown when a user isn't authorized.</p>
65
+ *
66
+ * @throws {@link ResourceNotFoundException} (client fault)
67
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
68
+ * resource.</p>
69
+ *
70
+ * @throws {@link TooManyFailedAttemptsException} (client fault)
71
+ * <p>This exception is thrown when the user has made too many failed attempts for a given
72
+ * action, such as sign-in.</p>
73
+ *
74
+ * @throws {@link TooManyRequestsException} (client fault)
75
+ * <p>This exception is thrown when the user has made too many requests for a given
76
+ * operation.</p>
77
+ *
78
+ * @throws {@link UnexpectedLambdaException} (client fault)
79
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
80
+ * Lambda.</p>
81
+ *
82
+ * @throws {@link UserLambdaValidationException} (client fault)
83
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
84
+ * with the Lambda service.</p>
85
+ *
86
+ * @throws {@link UserNotFoundException} (client fault)
87
+ * <p>This exception is thrown when a user isn't found.</p>
88
+ *
89
+ *
32
90
  */
33
91
  export declare class ConfirmSignUpCommand extends $Command<ConfirmSignUpCommandInput, ConfirmSignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
92
  readonly input: ConfirmSignUpCommandInput;