@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
@@ -29,6 +29,29 @@ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesRes
29
29
  * @see {@link AddCustomAttributesCommandOutput} for command's `response` shape.
30
30
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
31
31
  *
32
+ * @throws {@link InternalErrorException} (server fault)
33
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
34
+ *
35
+ * @throws {@link InvalidParameterException} (client fault)
36
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
37
+ * parameter.</p>
38
+ *
39
+ * @throws {@link NotAuthorizedException} (client fault)
40
+ * <p>This exception is thrown when a user isn't authorized.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
44
+ * resource.</p>
45
+ *
46
+ * @throws {@link TooManyRequestsException} (client fault)
47
+ * <p>This exception is thrown when the user has made too many requests for a given
48
+ * operation.</p>
49
+ *
50
+ * @throws {@link UserImportInProgressException} (client fault)
51
+ * <p>This exception is thrown when you're trying to modify a user pool while a user import
52
+ * job is in progress for that pool.</p>
53
+ *
54
+ *
32
55
  */
33
56
  export declare class AddCustomAttributesCommand extends $Command<AddCustomAttributesCommandInput, AddCustomAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
57
  readonly input: AddCustomAttributesCommandInput;
@@ -30,6 +30,28 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {
30
30
  * @see {@link AdminAddUserToGroupCommandOutput} 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 NotAuthorizedException} (client fault)
41
+ * <p>This exception is thrown when a user isn't authorized.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link TooManyRequestsException} (client fault)
48
+ * <p>This exception is thrown when the user has made too many requests for a given
49
+ * operation.</p>
50
+ *
51
+ * @throws {@link UserNotFoundException} (client fault)
52
+ * <p>This exception is thrown when a user isn't found.</p>
53
+ *
54
+ *
33
55
  */
34
56
  export declare class AdminAddUserToGroupCommand extends $Command<AdminAddUserToGroupCommandInput, AdminAddUserToGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminAddUserToGroupCommandInput;
@@ -31,6 +31,47 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
31
31
  * @see {@link AdminConfirmSignUpCommandOutput} 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 InvalidLambdaResponseException} (client fault)
38
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
39
+ *
40
+ * @throws {@link InvalidParameterException} (client fault)
41
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
42
+ * parameter.</p>
43
+ *
44
+ * @throws {@link LimitExceededException} (client fault)
45
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
46
+ * resource.</p>
47
+ *
48
+ * @throws {@link NotAuthorizedException} (client fault)
49
+ * <p>This exception is thrown when a user isn't authorized.</p>
50
+ *
51
+ * @throws {@link ResourceNotFoundException} (client fault)
52
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
53
+ * resource.</p>
54
+ *
55
+ * @throws {@link TooManyFailedAttemptsException} (client fault)
56
+ * <p>This exception is thrown when the user has made too many failed attempts for a given
57
+ * action, such as sign-in.</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 UnexpectedLambdaException} (client fault)
64
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
65
+ * Lambda.</p>
66
+ *
67
+ * @throws {@link UserLambdaValidationException} (client fault)
68
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
69
+ * with the Lambda service.</p>
70
+ *
71
+ * @throws {@link UserNotFoundException} (client fault)
72
+ * <p>This exception is thrown when a user isn't found.</p>
73
+ *
74
+ *
34
75
  */
35
76
  export declare class AdminConfirmSignUpCommand extends $Command<AdminConfirmSignUpCommandInput, AdminConfirmSignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
77
  readonly input: AdminConfirmSignUpCommandInput;
@@ -59,6 +59,66 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
59
59
  * @see {@link AdminCreateUserCommandOutput} for command's `response` shape.
60
60
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
61
61
  *
62
+ * @throws {@link CodeDeliveryFailureException} (client fault)
63
+ * <p>This exception is thrown when a verification code fails to deliver
64
+ * successfully.</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 NotAuthorizedException} (client fault)
90
+ * <p>This exception is thrown when a user isn't authorized.</p>
91
+ *
92
+ * @throws {@link PreconditionNotMetException} (client fault)
93
+ * <p>This exception is thrown when a precondition is not met.</p>
94
+ *
95
+ * @throws {@link ResourceNotFoundException} (client fault)
96
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
97
+ * resource.</p>
98
+ *
99
+ * @throws {@link TooManyRequestsException} (client fault)
100
+ * <p>This exception is thrown when the user has made too many requests for a given
101
+ * operation.</p>
102
+ *
103
+ * @throws {@link UnexpectedLambdaException} (client fault)
104
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
105
+ * Lambda.</p>
106
+ *
107
+ * @throws {@link UnsupportedUserStateException} (client fault)
108
+ * <p>The request failed because the user is in an unsupported state.</p>
109
+ *
110
+ * @throws {@link UserLambdaValidationException} (client fault)
111
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
112
+ * with the Lambda service.</p>
113
+ *
114
+ * @throws {@link UsernameExistsException} (client fault)
115
+ * <p>This exception is thrown when Amazon Cognito encounters a user name that already
116
+ * exists in the user pool.</p>
117
+ *
118
+ * @throws {@link UserNotFoundException} (client fault)
119
+ * <p>This exception is thrown when a user isn't found.</p>
120
+ *
121
+ *
62
122
  */
63
123
  export declare class AdminCreateUserCommand extends $Command<AdminCreateUserCommandInput, AdminCreateUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
64
124
  readonly input: AdminCreateUserCommandInput;
@@ -31,6 +31,28 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
31
31
  * @see {@link AdminDeleteUserAttributesCommandOutput} 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
+ *
34
56
  */
35
57
  export declare class AdminDeleteUserAttributesCommand extends $Command<AdminDeleteUserAttributesCommandInput, AdminDeleteUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
58
  readonly input: AdminDeleteUserAttributesCommandInput;
@@ -30,6 +30,28 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {
30
30
  * @see {@link AdminDeleteUserCommandOutput} 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 NotAuthorizedException} (client fault)
41
+ * <p>This exception is thrown when a user isn't authorized.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link TooManyRequestsException} (client fault)
48
+ * <p>This exception is thrown when the user has made too many requests for a given
49
+ * operation.</p>
50
+ *
51
+ * @throws {@link UserNotFoundException} (client fault)
52
+ * <p>This exception is thrown when a user isn't found.</p>
53
+ *
54
+ *
33
55
  */
34
56
  export declare class AdminDeleteUserCommand extends $Command<AdminDeleteUserCommandInput, AdminDeleteUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminDeleteUserCommandInput;
@@ -56,6 +56,35 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
56
56
  * @see {@link AdminDisableProviderForUserCommandOutput} for command's `response` shape.
57
57
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
58
58
  *
59
+ * @throws {@link AliasExistsException} (client fault)
60
+ * <p>This exception is thrown when a user tries to confirm the account with an email
61
+ * address or phone number that has already been supplied as an alias for a different
62
+ * user profile. This exception indicates that an account with this email address or phone
63
+ * already exists in a user pool that you've configured to use email address or phone
64
+ * number as a sign-in alias.</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 InvalidParameterException} (client fault)
70
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
71
+ * parameter.</p>
72
+ *
73
+ * @throws {@link NotAuthorizedException} (client fault)
74
+ * <p>This exception is thrown when a user isn't authorized.</p>
75
+ *
76
+ * @throws {@link ResourceNotFoundException} (client fault)
77
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
78
+ * resource.</p>
79
+ *
80
+ * @throws {@link TooManyRequestsException} (client fault)
81
+ * <p>This exception is thrown when the user has made too many requests for a given
82
+ * operation.</p>
83
+ *
84
+ * @throws {@link UserNotFoundException} (client fault)
85
+ * <p>This exception is thrown when a user isn't found.</p>
86
+ *
87
+ *
59
88
  */
60
89
  export declare class AdminDisableProviderForUserCommand extends $Command<AdminDisableProviderForUserCommandInput, AdminDisableProviderForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
61
90
  readonly input: AdminDisableProviderForUserCommandInput;
@@ -31,6 +31,28 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
31
31
  * @see {@link AdminDisableUserCommandOutput} 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
+ *
34
56
  */
35
57
  export declare class AdminDisableUserCommand extends $Command<AdminDisableUserCommandInput, AdminDisableUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
58
  readonly input: AdminDisableUserCommandInput;
@@ -30,6 +30,28 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
30
30
  * @see {@link AdminEnableUserCommandOutput} 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 NotAuthorizedException} (client fault)
41
+ * <p>This exception is thrown when a user isn't authorized.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link TooManyRequestsException} (client fault)
48
+ * <p>This exception is thrown when the user has made too many requests for a given
49
+ * operation.</p>
50
+ *
51
+ * @throws {@link UserNotFoundException} (client fault)
52
+ * <p>This exception is thrown when a user isn't found.</p>
53
+ *
54
+ *
33
55
  */
34
56
  export declare class AdminEnableUserCommand extends $Command<AdminEnableUserCommandInput, AdminEnableUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminEnableUserCommandInput;
@@ -30,6 +30,31 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {
30
30
  * @see {@link AdminForgetDeviceCommandOutput} 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 AdminForgetDeviceCommand extends $Command<AdminForgetDeviceCommandInput, AdminForgetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
60
  readonly input: AdminForgetDeviceCommandInput;
@@ -30,6 +30,28 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
30
30
  * @see {@link AdminGetDeviceCommandOutput} 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
+ *
33
55
  */
34
56
  export declare class AdminGetDeviceCommand extends $Command<AdminGetDeviceCommandInput, AdminGetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminGetDeviceCommandInput;
@@ -31,6 +31,28 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
31
31
  * @see {@link AdminGetUserCommandOutput} 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
+ *
34
56
  */
35
57
  export declare class AdminGetUserCommand extends $Command<AdminGetUserCommandInput, AdminGetUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
58
  readonly input: AdminGetUserCommandInput;
@@ -49,6 +49,62 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
49
49
  * @see {@link AdminInitiateAuthCommandOutput} for command's `response` shape.
50
50
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
51
51
  *
52
+ * @throws {@link InternalErrorException} (server fault)
53
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
54
+ *
55
+ * @throws {@link InvalidLambdaResponseException} (client fault)
56
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</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 InvalidSmsRoleAccessPolicyException} (client fault)
63
+ * <p>This exception is returned when the role provided for SMS configuration doesn't have
64
+ * permission to publish using Amazon SNS.</p>
65
+ *
66
+ * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
67
+ * <p>This exception is thrown when the trust relationship is not valid for the role
68
+ * provided for SMS configuration. This can happen if you don't trust
69
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
70
+ * not match what is provided in the SMS configuration for the user pool.</p>
71
+ *
72
+ * @throws {@link InvalidUserPoolConfigurationException} (client fault)
73
+ * <p>This exception is thrown when the user pool configuration is not valid.</p>
74
+ *
75
+ * @throws {@link MFAMethodNotFoundException} (client fault)
76
+ * <p>This exception is thrown when Amazon Cognito can't find a multi-factor authentication
77
+ * (MFA) method.</p>
78
+ *
79
+ * @throws {@link NotAuthorizedException} (client fault)
80
+ * <p>This exception is thrown when a user isn't authorized.</p>
81
+ *
82
+ * @throws {@link PasswordResetRequiredException} (client fault)
83
+ * <p>This exception is thrown when a password reset is required.</p>
84
+ *
85
+ * @throws {@link ResourceNotFoundException} (client fault)
86
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
87
+ * resource.</p>
88
+ *
89
+ * @throws {@link TooManyRequestsException} (client fault)
90
+ * <p>This exception is thrown when the user has made too many requests for a given
91
+ * operation.</p>
92
+ *
93
+ * @throws {@link UnexpectedLambdaException} (client fault)
94
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
95
+ * Lambda.</p>
96
+ *
97
+ * @throws {@link UserLambdaValidationException} (client fault)
98
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
99
+ * with the Lambda service.</p>
100
+ *
101
+ * @throws {@link UserNotConfirmedException} (client fault)
102
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
103
+ *
104
+ * @throws {@link UserNotFoundException} (client fault)
105
+ * <p>This exception is thrown when a user isn't found.</p>
106
+ *
107
+ *
52
108
  */
53
109
  export declare class AdminInitiateAuthCommand extends $Command<AdminInitiateAuthCommandInput, AdminInitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
54
110
  readonly input: AdminInitiateAuthCommandInput;
@@ -47,6 +47,39 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
47
47
  * @see {@link AdminLinkProviderForUserCommandOutput} for command's `response` shape.
48
48
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
49
49
  *
50
+ * @throws {@link AliasExistsException} (client fault)
51
+ * <p>This exception is thrown when a user tries to confirm the account with an email
52
+ * address or phone number that has already been supplied as an alias for a different
53
+ * user profile. This exception indicates that an account with this email address or phone
54
+ * already exists in a user pool that you've configured to use email address or phone
55
+ * number as a sign-in alias.</p>
56
+ *
57
+ * @throws {@link InternalErrorException} (server fault)
58
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
59
+ *
60
+ * @throws {@link InvalidParameterException} (client fault)
61
+ * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
62
+ * parameter.</p>
63
+ *
64
+ * @throws {@link LimitExceededException} (client fault)
65
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
66
+ * resource.</p>
67
+ *
68
+ * @throws {@link NotAuthorizedException} (client fault)
69
+ * <p>This exception is thrown when a user isn't authorized.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
73
+ * resource.</p>
74
+ *
75
+ * @throws {@link TooManyRequestsException} (client fault)
76
+ * <p>This exception is thrown when the user has made too many requests for a given
77
+ * operation.</p>
78
+ *
79
+ * @throws {@link UserNotFoundException} (client fault)
80
+ * <p>This exception is thrown when a user isn't found.</p>
81
+ *
82
+ *
50
83
  */
51
84
  export declare class AdminLinkProviderForUserCommand extends $Command<AdminLinkProviderForUserCommandInput, AdminLinkProviderForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
52
85
  readonly input: AdminLinkProviderForUserCommandInput;
@@ -30,6 +30,28 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
30
30
  * @see {@link AdminListDevicesCommandOutput} 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
+ *
33
55
  */
34
56
  export declare class AdminListDevicesCommand extends $Command<AdminListDevicesCommandInput, AdminListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminListDevicesCommandInput;
@@ -30,6 +30,28 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
30
30
  * @see {@link AdminListGroupsForUserCommandOutput} 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 NotAuthorizedException} (client fault)
41
+ * <p>This exception is thrown when a user isn't authorized.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link TooManyRequestsException} (client fault)
48
+ * <p>This exception is thrown when the user has made too many requests for a given
49
+ * operation.</p>
50
+ *
51
+ * @throws {@link UserNotFoundException} (client fault)
52
+ * <p>This exception is thrown when a user isn't found.</p>
53
+ *
54
+ *
33
55
  */
34
56
  export declare class AdminListGroupsForUserCommand extends $Command<AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminListGroupsForUserCommandInput;
@@ -30,6 +30,31 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
30
30
  * @see {@link AdminListUserAuthEventsCommandOutput} 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 NotAuthorizedException} (client fault)
41
+ * <p>This exception is thrown when a user isn't authorized.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link TooManyRequestsException} (client fault)
48
+ * <p>This exception is thrown when the user has made too many requests for a given
49
+ * operation.</p>
50
+ *
51
+ * @throws {@link UserNotFoundException} (client fault)
52
+ * <p>This exception is thrown when a user isn't found.</p>
53
+ *
54
+ * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
55
+ * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
56
+ *
57
+ *
33
58
  */
34
59
  export declare class AdminListUserAuthEventsCommand extends $Command<AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
60
  readonly input: AdminListUserAuthEventsCommandInput;
@@ -30,6 +30,28 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
30
30
  * @see {@link AdminRemoveUserFromGroupCommandOutput} 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 NotAuthorizedException} (client fault)
41
+ * <p>This exception is thrown when a user isn't authorized.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
45
+ * resource.</p>
46
+ *
47
+ * @throws {@link TooManyRequestsException} (client fault)
48
+ * <p>This exception is thrown when the user has made too many requests for a given
49
+ * operation.</p>
50
+ *
51
+ * @throws {@link UserNotFoundException} (client fault)
52
+ * <p>This exception is thrown when a user isn't found.</p>
53
+ *
54
+ *
33
55
  */
34
56
  export declare class AdminRemoveUserFromGroupCommand extends $Command<AdminRemoveUserFromGroupCommandInput, AdminRemoveUserFromGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
57
  readonly input: AdminRemoveUserFromGroupCommandInput;