@aws-sdk/client-cognito-identity-provider 3.289.0 → 3.290.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 +29 -29
@@ -29,6 +29,28 @@ export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse,
29
29
  * @see {@link DescribeUserPoolCommandOutput} 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 UserPoolTaggingException} (client fault)
51
+ * <p>This exception is thrown when a user pool tag can't be set or updated.</p>
52
+ *
53
+ *
32
54
  */
33
55
  export declare class DescribeUserPoolCommand extends $Command<DescribeUserPoolCommandInput, DescribeUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
56
  readonly input: DescribeUserPoolCommandInput;
@@ -29,6 +29,21 @@ export interface DescribeUserPoolDomainCommandOutput extends DescribeUserPoolDom
29
29
  * @see {@link DescribeUserPoolDomainCommandOutput} 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
+ *
32
47
  */
33
48
  export declare class DescribeUserPoolDomainCommand extends $Command<DescribeUserPoolDomainCommandInput, DescribeUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
49
  readonly input: DescribeUserPoolDomainCommandInput;
@@ -29,6 +29,40 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {
29
29
  * @see {@link ForgetDeviceCommandOutput} 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 InvalidUserPoolConfigurationException} (client fault)
43
+ * <p>This exception is thrown when the user pool configuration is not valid.</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 PasswordResetRequiredException} (client fault)
49
+ * <p>This exception is thrown when a password reset is required.</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 TooManyRequestsException} (client fault)
56
+ * <p>This exception is thrown when the user has made too many requests for a given
57
+ * operation.</p>
58
+ *
59
+ * @throws {@link UserNotConfirmedException} (client fault)
60
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
61
+ *
62
+ * @throws {@link UserNotFoundException} (client fault)
63
+ * <p>This exception is thrown when a user isn't found.</p>
64
+ *
65
+ *
32
66
  */
33
67
  export declare class ForgetDeviceCommand extends $Command<ForgetDeviceCommandInput, ForgetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
68
  readonly input: ForgetDeviceCommandInput;
@@ -54,6 +54,64 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
54
54
  * @see {@link ForgotPasswordCommandOutput} for command's `response` shape.
55
55
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
56
56
  *
57
+ * @throws {@link CodeDeliveryFailureException} (client fault)
58
+ * <p>This exception is thrown when a verification code fails to deliver
59
+ * successfully.</p>
60
+ *
61
+ * @throws {@link ForbiddenException} (client fault)
62
+ * <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>
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 LimitExceededException} (client fault)
89
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
90
+ * resource.</p>
91
+ *
92
+ * @throws {@link NotAuthorizedException} (client fault)
93
+ * <p>This exception is thrown when a user isn't authorized.</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 UserLambdaValidationException} (client fault)
108
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
109
+ * with the Lambda service.</p>
110
+ *
111
+ * @throws {@link UserNotFoundException} (client fault)
112
+ * <p>This exception is thrown when a user isn't found.</p>
113
+ *
114
+ *
57
115
  */
58
116
  export declare class ForgotPasswordCommand extends $Command<ForgotPasswordCommandInput, ForgotPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
59
117
  readonly input: ForgotPasswordCommandInput;
@@ -30,6 +30,25 @@ export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __Metad
30
30
  * @see {@link GetCSVHeaderCommandOutput} 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
+ *
33
52
  */
34
53
  export declare class GetCSVHeaderCommand extends $Command<GetCSVHeaderCommandInput, GetCSVHeaderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
54
  readonly input: GetCSVHeaderCommandInput;
@@ -29,6 +29,40 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
29
29
  * @see {@link GetDeviceCommandOutput} 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 InvalidUserPoolConfigurationException} (client fault)
43
+ * <p>This exception is thrown when the user pool configuration is not valid.</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 PasswordResetRequiredException} (client fault)
49
+ * <p>This exception is thrown when a password reset is required.</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 TooManyRequestsException} (client fault)
56
+ * <p>This exception is thrown when the user has made too many requests for a given
57
+ * operation.</p>
58
+ *
59
+ * @throws {@link UserNotConfirmedException} (client fault)
60
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
61
+ *
62
+ * @throws {@link UserNotFoundException} (client fault)
63
+ * <p>This exception is thrown when a user isn't found.</p>
64
+ *
65
+ *
32
66
  */
33
67
  export declare class GetDeviceCommand extends $Command<GetDeviceCommandInput, GetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
68
  readonly input: GetDeviceCommandInput;
@@ -30,6 +30,25 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
30
30
  * @see {@link GetGroupCommandOutput} 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
+ *
33
52
  */
34
53
  export declare class GetGroupCommand extends $Command<GetGroupCommandInput, GetGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
54
  readonly input: GetGroupCommandInput;
@@ -29,6 +29,25 @@ export interface GetIdentityProviderByIdentifierCommandOutput extends GetIdentit
29
29
  * @see {@link GetIdentityProviderByIdentifierCommandOutput} 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
+ *
32
51
  */
33
52
  export declare class GetIdentityProviderByIdentifierCommand extends $Command<GetIdentityProviderByIdentifierCommandInput, GetIdentityProviderByIdentifierCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
53
  readonly input: GetIdentityProviderByIdentifierCommandInput;
@@ -31,6 +31,18 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
31
31
  * @see {@link GetSigningCertificateCommandOutput} 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 ResourceNotFoundException} (client fault)
42
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
43
+ * resource.</p>
44
+ *
45
+ *
34
46
  */
35
47
  export declare class GetSigningCertificateCommand extends $Command<GetSigningCertificateCommandInput, GetSigningCertificateCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
48
  readonly input: GetSigningCertificateCommandInput;
@@ -33,6 +33,25 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo
33
33
  * @see {@link GetUICustomizationCommandOutput} 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 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
+ *
36
55
  */
37
56
  export declare class GetUICustomizationCommand extends $Command<GetUICustomizationCommandInput, GetUICustomizationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
38
57
  readonly input: GetUICustomizationCommandInput;
@@ -49,6 +49,70 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
49
49
  * @see {@link GetUserAttributeVerificationCodeCommandOutput} for command's `response` shape.
50
50
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
51
51
  *
52
+ * @throws {@link CodeDeliveryFailureException} (client fault)
53
+ * <p>This exception is thrown when a verification code fails to deliver
54
+ * successfully.</p>
55
+ *
56
+ * @throws {@link ForbiddenException} (client fault)
57
+ * <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>
58
+ *
59
+ * @throws {@link InternalErrorException} (server fault)
60
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
61
+ *
62
+ * @throws {@link InvalidEmailRoleAccessPolicyException} (client fault)
63
+ * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
64
+ * status code: 400.</p>
65
+ *
66
+ * @throws {@link InvalidLambdaResponseException} (client fault)
67
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</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 InvalidSmsRoleAccessPolicyException} (client fault)
74
+ * <p>This exception is returned when the role provided for SMS configuration doesn't have
75
+ * permission to publish using Amazon SNS.</p>
76
+ *
77
+ * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
78
+ * <p>This exception is thrown when the trust relationship is not valid for the role
79
+ * provided for SMS configuration. This can happen if you don't trust
80
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
81
+ * not match what is provided in the SMS configuration for the user pool.</p>
82
+ *
83
+ * @throws {@link LimitExceededException} (client fault)
84
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
85
+ * resource.</p>
86
+ *
87
+ * @throws {@link NotAuthorizedException} (client fault)
88
+ * <p>This exception is thrown when a user isn't authorized.</p>
89
+ *
90
+ * @throws {@link PasswordResetRequiredException} (client fault)
91
+ * <p>This exception is thrown when a password reset is required.</p>
92
+ *
93
+ * @throws {@link ResourceNotFoundException} (client fault)
94
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
95
+ * resource.</p>
96
+ *
97
+ * @throws {@link TooManyRequestsException} (client fault)
98
+ * <p>This exception is thrown when the user has made too many requests for a given
99
+ * operation.</p>
100
+ *
101
+ * @throws {@link UnexpectedLambdaException} (client fault)
102
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
103
+ * Lambda.</p>
104
+ *
105
+ * @throws {@link UserLambdaValidationException} (client fault)
106
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
107
+ * with the Lambda service.</p>
108
+ *
109
+ * @throws {@link UserNotConfirmedException} (client fault)
110
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
111
+ *
112
+ * @throws {@link UserNotFoundException} (client fault)
113
+ * <p>This exception is thrown when a user isn't found.</p>
114
+ *
115
+ *
52
116
  */
53
117
  export declare class GetUserAttributeVerificationCodeCommand extends $Command<GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
54
118
  readonly input: GetUserAttributeVerificationCodeCommandInput;
@@ -29,6 +29,37 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
29
29
  * @see {@link GetUserCommandOutput} 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 NotAuthorizedException} (client fault)
43
+ * <p>This exception is thrown when a user isn't authorized.</p>
44
+ *
45
+ * @throws {@link PasswordResetRequiredException} (client fault)
46
+ * <p>This exception is thrown when a password reset is required.</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 UserNotConfirmedException} (client fault)
57
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
58
+ *
59
+ * @throws {@link UserNotFoundException} (client fault)
60
+ * <p>This exception is thrown when a user isn't found.</p>
61
+ *
62
+ *
32
63
  */
33
64
  export declare class GetUserCommand extends $Command<GetUserCommandInput, GetUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
65
  readonly input: GetUserCommandInput;
@@ -29,6 +29,25 @@ export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR
29
29
  * @see {@link GetUserPoolMfaConfigCommandOutput} 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
+ *
32
51
  */
33
52
  export declare class GetUserPoolMfaConfigCommand extends $Command<GetUserPoolMfaConfigCommandInput, GetUserPoolMfaConfigCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
53
  readonly input: GetUserPoolMfaConfigCommandInput;
@@ -31,6 +31,34 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
31
31
  * @see {@link GlobalSignOutCommandOutput} for command's `response` shape.
32
32
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
33
33
  *
34
+ * @throws {@link ForbiddenException} (client fault)
35
+ * <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>
36
+ *
37
+ * @throws {@link InternalErrorException} (server fault)
38
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</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 NotAuthorizedException} (client fault)
45
+ * <p>This exception is thrown when a user isn't authorized.</p>
46
+ *
47
+ * @throws {@link PasswordResetRequiredException} (client fault)
48
+ * <p>This exception is thrown when a password reset is required.</p>
49
+ *
50
+ * @throws {@link ResourceNotFoundException} (client fault)
51
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
52
+ * resource.</p>
53
+ *
54
+ * @throws {@link TooManyRequestsException} (client fault)
55
+ * <p>This exception is thrown when the user has made too many requests for a given
56
+ * operation.</p>
57
+ *
58
+ * @throws {@link UserNotConfirmedException} (client fault)
59
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
60
+ *
61
+ *
34
62
  */
35
63
  export declare class GlobalSignOutCommand extends $Command<GlobalSignOutCommandInput, GlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
36
64
  readonly input: GlobalSignOutCommandInput;
@@ -48,6 +48,61 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
48
48
  * @see {@link InitiateAuthCommandOutput} for command's `response` shape.
49
49
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
50
50
  *
51
+ * @throws {@link ForbiddenException} (client fault)
52
+ * <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>
53
+ *
54
+ * @throws {@link InternalErrorException} (server fault)
55
+ * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
56
+ *
57
+ * @throws {@link InvalidLambdaResponseException} (client fault)
58
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</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 InvalidSmsRoleAccessPolicyException} (client fault)
65
+ * <p>This exception is returned when the role provided for SMS configuration doesn't have
66
+ * permission to publish using Amazon SNS.</p>
67
+ *
68
+ * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
69
+ * <p>This exception is thrown when the trust relationship is not valid for the role
70
+ * provided for SMS configuration. This can happen if you don't trust
71
+ * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
72
+ * not match what is provided in the SMS configuration for the user pool.</p>
73
+ *
74
+ * @throws {@link InvalidUserPoolConfigurationException} (client fault)
75
+ * <p>This exception is thrown when the user pool configuration is not valid.</p>
76
+ *
77
+ * @throws {@link NotAuthorizedException} (client fault)
78
+ * <p>This exception is thrown when a user isn't authorized.</p>
79
+ *
80
+ * @throws {@link PasswordResetRequiredException} (client fault)
81
+ * <p>This exception is thrown when a password reset is required.</p>
82
+ *
83
+ * @throws {@link ResourceNotFoundException} (client fault)
84
+ * <p>This exception is thrown when the Amazon Cognito service can't find the requested
85
+ * resource.</p>
86
+ *
87
+ * @throws {@link TooManyRequestsException} (client fault)
88
+ * <p>This exception is thrown when the user has made too many requests for a given
89
+ * operation.</p>
90
+ *
91
+ * @throws {@link UnexpectedLambdaException} (client fault)
92
+ * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
93
+ * Lambda.</p>
94
+ *
95
+ * @throws {@link UserLambdaValidationException} (client fault)
96
+ * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
97
+ * with the Lambda service.</p>
98
+ *
99
+ * @throws {@link UserNotConfirmedException} (client fault)
100
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
101
+ *
102
+ * @throws {@link UserNotFoundException} (client fault)
103
+ * <p>This exception is thrown when a user isn't found.</p>
104
+ *
105
+ *
51
106
  */
52
107
  export declare class InitiateAuthCommand extends $Command<InitiateAuthCommandInput, InitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
53
108
  readonly input: InitiateAuthCommandInput;
@@ -29,6 +29,40 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
29
29
  * @see {@link ListDevicesCommandOutput} 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 InvalidUserPoolConfigurationException} (client fault)
43
+ * <p>This exception is thrown when the user pool configuration is not valid.</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 PasswordResetRequiredException} (client fault)
49
+ * <p>This exception is thrown when a password reset is required.</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 TooManyRequestsException} (client fault)
56
+ * <p>This exception is thrown when the user has made too many requests for a given
57
+ * operation.</p>
58
+ *
59
+ * @throws {@link UserNotConfirmedException} (client fault)
60
+ * <p>This exception is thrown when a user isn't confirmed successfully.</p>
61
+ *
62
+ * @throws {@link UserNotFoundException} (client fault)
63
+ * <p>This exception is thrown when a user isn't found.</p>
64
+ *
65
+ *
32
66
  */
33
67
  export declare class ListDevicesCommand extends $Command<ListDevicesCommandInput, ListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
34
68
  readonly input: ListDevicesCommandInput;
@@ -30,6 +30,25 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
30
30
  * @see {@link ListGroupsCommandOutput} 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
+ *
33
52
  */
34
53
  export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
35
54
  readonly input: ListGroupsCommandInput;