@aws-sdk/client-cognito-identity-provider 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/dist-types/commands/AddCustomAttributesCommand.d.ts +4 -0
  2. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +4 -0
  3. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +4 -0
  4. package/dist-types/commands/AdminCreateUserCommand.d.ts +24 -0
  5. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +4 -0
  6. package/dist-types/commands/AdminDeleteUserCommand.d.ts +4 -0
  7. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +4 -0
  8. package/dist-types/commands/AdminDisableUserCommand.d.ts +4 -0
  9. package/dist-types/commands/AdminEnableUserCommand.d.ts +4 -0
  10. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +4 -0
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +17 -0
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +26 -0
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +21 -0
  14. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +4 -0
  15. package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -0
  16. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +17 -0
  17. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +37 -0
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +4 -0
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +4 -0
  20. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +21 -0
  21. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +4 -0
  22. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +4 -0
  23. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +4 -0
  24. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +4 -0
  25. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +4 -0
  26. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +4 -0
  27. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +4 -0
  28. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +7 -0
  29. package/dist-types/commands/ChangePasswordCommand.d.ts +4 -0
  30. package/dist-types/commands/ConfirmDeviceCommand.d.ts +6 -0
  31. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +4 -0
  32. package/dist-types/commands/ConfirmSignUpCommand.d.ts +4 -0
  33. package/dist-types/commands/CreateGroupCommand.d.ts +14 -0
  34. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +21 -0
  35. package/dist-types/commands/CreateResourceServerCommand.d.ts +16 -0
  36. package/dist-types/commands/CreateUserImportJobCommand.d.ts +20 -0
  37. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +58 -0
  38. package/dist-types/commands/CreateUserPoolCommand.d.ts +136 -0
  39. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +6 -0
  40. package/dist-types/commands/DeleteGroupCommand.d.ts +4 -0
  41. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +4 -0
  42. package/dist-types/commands/DeleteResourceServerCommand.d.ts +4 -0
  43. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +4 -0
  44. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  45. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +4 -0
  46. package/dist-types/commands/DeleteUserPoolCommand.d.ts +4 -0
  47. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +4 -0
  48. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +21 -0
  49. package/dist-types/commands/DescribeResourceServerCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +62 -0
  51. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +20 -0
  52. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +58 -0
  53. package/dist-types/commands/DescribeUserPoolCommand.d.ts +136 -0
  54. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +17 -0
  55. package/dist-types/commands/ForgetDeviceCommand.d.ts +4 -0
  56. package/dist-types/commands/ForgotPasswordCommand.d.ts +10 -0
  57. package/dist-types/commands/GetCSVHeaderCommand.d.ts +9 -0
  58. package/dist-types/commands/GetDeviceCommand.d.ts +17 -0
  59. package/dist-types/commands/GetGroupCommand.d.ts +14 -0
  60. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +21 -0
  61. package/dist-types/commands/GetSigningCertificateCommand.d.ts +6 -0
  62. package/dist-types/commands/GetUICustomizationCommand.d.ts +14 -0
  63. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -0
  64. package/dist-types/commands/GetUserCommand.d.ts +22 -0
  65. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +17 -0
  66. package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -0
  67. package/dist-types/commands/InitiateAuthCommand.d.ts +21 -0
  68. package/dist-types/commands/ListDevicesCommand.d.ts +20 -0
  69. package/dist-types/commands/ListGroupsCommand.d.ts +17 -0
  70. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +14 -0
  71. package/dist-types/commands/ListResourceServersCommand.d.ts +19 -0
  72. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  73. package/dist-types/commands/ListUserImportJobsCommand.d.ts +23 -0
  74. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +13 -0
  75. package/dist-types/commands/ListUserPoolsCommand.d.ts +36 -0
  76. package/dist-types/commands/ListUsersCommand.d.ts +27 -0
  77. package/dist-types/commands/ListUsersInGroupCommand.d.ts +27 -0
  78. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -0
  79. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +21 -0
  80. package/dist-types/commands/RevokeTokenCommand.d.ts +4 -0
  81. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +62 -0
  82. package/dist-types/commands/SetUICustomizationCommand.d.ts +14 -0
  83. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -0
  84. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +17 -0
  85. package/dist-types/commands/SetUserSettingsCommand.d.ts +4 -0
  86. package/dist-types/commands/SignUpCommand.d.ts +12 -0
  87. package/dist-types/commands/StartUserImportJobCommand.d.ts +20 -0
  88. package/dist-types/commands/StopUserImportJobCommand.d.ts +20 -0
  89. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  90. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  91. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +4 -0
  92. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +4 -0
  93. package/dist-types/commands/UpdateGroupCommand.d.ts +14 -0
  94. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +21 -0
  95. package/dist-types/commands/UpdateResourceServerCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -0
  97. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +58 -0
  98. package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -0
  99. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +6 -0
  100. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +7 -0
  101. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +4 -0
  102. package/package.json +3 -3
@@ -38,6 +38,8 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
38
38
  * };
39
39
  * const command = new AdminUserGlobalSignOutCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param AdminUserGlobalSignOutCommandInput - {@link AdminUserGlobalSignOutCommandInput}
@@ -67,6 +69,8 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
67
69
  * @throws {@link UserNotFoundException} (client fault)
68
70
  * <p>This exception is thrown when a user isn't found.</p>
69
71
  *
72
+ * @throws {@link CognitoIdentityProviderServiceException}
73
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
70
74
  *
71
75
  */
72
76
  export declare class AdminUserGlobalSignOutCommand extends $Command<AdminUserGlobalSignOutCommandInput, AdminUserGlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -48,6 +48,11 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
48
48
  * };
49
49
  * const command = new AssociateSoftwareTokenCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // AssociateSoftwareTokenResponse
52
+ * // SecretCode: "STRING_VALUE",
53
+ * // Session: "STRING_VALUE",
54
+ * // };
55
+ *
51
56
  * ```
52
57
  *
53
58
  * @param AssociateSoftwareTokenCommandInput - {@link AssociateSoftwareTokenCommandInput}
@@ -81,6 +86,8 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
81
86
  * <p>This exception is thrown when the software token time-based one-time password (TOTP)
82
87
  * multi-factor authentication (MFA) isn't activated for the user pool.</p>
83
88
  *
89
+ * @throws {@link CognitoIdentityProviderServiceException}
90
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
84
91
  *
85
92
  */
86
93
  export declare class AssociateSoftwareTokenCommand extends $Command<AssociateSoftwareTokenCommandInput, AssociateSoftwareTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
33
33
  * };
34
34
  * const command = new ChangePasswordCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param ChangePasswordCommandInput - {@link ChangePasswordCommandInput}
@@ -78,6 +80,8 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
78
80
  * @throws {@link UserNotFoundException} (client fault)
79
81
  * <p>This exception is thrown when a user isn't found.</p>
80
82
  *
83
+ * @throws {@link CognitoIdentityProviderServiceException}
84
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
81
85
  *
82
86
  */
83
87
  export declare class ChangePasswordCommand extends $Command<ChangePasswordCommandInput, ChangePasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -38,6 +38,10 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
38
38
  * };
39
39
  * const command = new ConfirmDeviceCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ConfirmDeviceResponse
42
+ * // UserConfirmationNecessary: true || false,
43
+ * // };
44
+ *
41
45
  * ```
42
46
  *
43
47
  * @param ConfirmDeviceCommandInput - {@link ConfirmDeviceCommandInput}
@@ -89,6 +93,8 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
89
93
  * @throws {@link UserNotFoundException} (client fault)
90
94
  * <p>This exception is thrown when a user isn't found.</p>
91
95
  *
96
+ * @throws {@link CognitoIdentityProviderServiceException}
97
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
92
98
  *
93
99
  */
94
100
  export declare class ConfirmDeviceCommand extends $Command<ConfirmDeviceCommandInput, ConfirmDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
45
45
  * };
46
46
  * const command = new ConfirmForgotPasswordCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param ConfirmForgotPasswordCommandInput - {@link ConfirmForgotPasswordCommandInput}
@@ -109,6 +111,8 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
109
111
  * @throws {@link UserNotFoundException} (client fault)
110
112
  * <p>This exception is thrown when a user isn't found.</p>
111
113
  *
114
+ * @throws {@link CognitoIdentityProviderServiceException}
115
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
112
116
  *
113
117
  */
114
118
  export declare class ConfirmForgotPasswordCommand extends $Command<ConfirmForgotPasswordCommandInput, ConfirmForgotPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
45
45
  * };
46
46
  * const command = new ConfirmSignUpCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param ConfirmSignUpCommandInput - {@link ConfirmSignUpCommandInput}
@@ -110,6 +112,8 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
110
112
  * @throws {@link UserNotFoundException} (client fault)
111
113
  * <p>This exception is thrown when a user isn't found.</p>
112
114
  *
115
+ * @throws {@link CognitoIdentityProviderServiceException}
116
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
113
117
  *
114
118
  */
115
119
  export declare class ConfirmSignUpCommand extends $Command<ConfirmSignUpCommandInput, ConfirmSignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -36,6 +36,18 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
36
36
  * };
37
37
  * const command = new CreateGroupCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // CreateGroupResponse
40
+ * // Group: { // GroupType
41
+ * // GroupName: "STRING_VALUE",
42
+ * // UserPoolId: "STRING_VALUE",
43
+ * // Description: "STRING_VALUE",
44
+ * // RoleArn: "STRING_VALUE",
45
+ * // Precedence: Number("int"),
46
+ * // LastModifiedDate: new Date("TIMESTAMP"),
47
+ * // CreationDate: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // };
50
+ *
39
51
  * ```
40
52
  *
41
53
  * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
@@ -70,6 +82,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
70
82
  * <p>This exception is thrown when the user has made too many requests for a given
71
83
  * operation.</p>
72
84
  *
85
+ * @throws {@link CognitoIdentityProviderServiceException}
86
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
73
87
  *
74
88
  */
75
89
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -42,6 +42,25 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi
42
42
  * };
43
43
  * const command = new CreateIdentityProviderCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // CreateIdentityProviderResponse
46
+ * // IdentityProvider: { // IdentityProviderType
47
+ * // UserPoolId: "STRING_VALUE",
48
+ * // ProviderName: "STRING_VALUE",
49
+ * // ProviderType: "SAML" || "Facebook" || "Google" || "LoginWithAmazon" || "SignInWithApple" || "OIDC",
50
+ * // ProviderDetails: { // ProviderDetailsType
51
+ * // "<keys>": "STRING_VALUE",
52
+ * // },
53
+ * // AttributeMapping: { // AttributeMappingType
54
+ * // "<keys>": "STRING_VALUE",
55
+ * // },
56
+ * // IdpIdentifiers: [ // IdpIdentifiersListType
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // LastModifiedDate: new Date("TIMESTAMP"),
60
+ * // CreationDate: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // };
63
+ *
45
64
  * ```
46
65
  *
47
66
  * @param CreateIdentityProviderCommandInput - {@link CreateIdentityProviderCommandInput}
@@ -76,6 +95,8 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi
76
95
  * <p>This exception is thrown when the user has made too many requests for a given
77
96
  * operation.</p>
78
97
  *
98
+ * @throws {@link CognitoIdentityProviderServiceException}
99
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
79
100
  *
80
101
  */
81
102
  export declare class CreateIdentityProviderCommand extends $Command<CreateIdentityProviderCommandInput, CreateIdentityProviderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -39,6 +39,20 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR
39
39
  * };
40
40
  * const command = new CreateResourceServerCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CreateResourceServerResponse
43
+ * // ResourceServer: { // ResourceServerType
44
+ * // UserPoolId: "STRING_VALUE",
45
+ * // Identifier: "STRING_VALUE",
46
+ * // Name: "STRING_VALUE",
47
+ * // Scopes: [ // ResourceServerScopeListType
48
+ * // { // ResourceServerScopeType
49
+ * // ScopeName: "STRING_VALUE", // required
50
+ * // ScopeDescription: "STRING_VALUE", // required
51
+ * // },
52
+ * // ],
53
+ * // },
54
+ * // };
55
+ *
42
56
  * ```
43
57
  *
44
58
  * @param CreateResourceServerCommandInput - {@link CreateResourceServerCommandInput}
@@ -69,6 +83,8 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR
69
83
  * <p>This exception is thrown when the user has made too many requests for a given
70
84
  * operation.</p>
71
85
  *
86
+ * @throws {@link CognitoIdentityProviderServiceException}
87
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
72
88
  *
73
89
  */
74
90
  export declare class CreateResourceServerCommand extends $Command<CreateResourceServerCommandInput, CreateResourceServerCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,24 @@ export interface CreateUserImportJobCommandOutput extends CreateUserImportJobRes
33
33
  * };
34
34
  * const command = new CreateUserImportJobCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CreateUserImportJobResponse
37
+ * // UserImportJob: { // UserImportJobType
38
+ * // JobName: "STRING_VALUE",
39
+ * // JobId: "STRING_VALUE",
40
+ * // UserPoolId: "STRING_VALUE",
41
+ * // PreSignedUrl: "STRING_VALUE",
42
+ * // CreationDate: new Date("TIMESTAMP"),
43
+ * // StartDate: new Date("TIMESTAMP"),
44
+ * // CompletionDate: new Date("TIMESTAMP"),
45
+ * // Status: "Created" || "Pending" || "InProgress" || "Stopping" || "Expired" || "Stopped" || "Failed" || "Succeeded",
46
+ * // CloudWatchLogsRoleArn: "STRING_VALUE",
47
+ * // ImportedUsers: Number("long"),
48
+ * // SkippedUsers: Number("long"),
49
+ * // FailedUsers: Number("long"),
50
+ * // CompletionMessage: "STRING_VALUE",
51
+ * // },
52
+ * // };
53
+ *
36
54
  * ```
37
55
  *
38
56
  * @param CreateUserImportJobCommandInput - {@link CreateUserImportJobCommandInput}
@@ -66,6 +84,8 @@ export interface CreateUserImportJobCommandOutput extends CreateUserImportJobRes
66
84
  * <p>This exception is thrown when the user has made too many requests for a given
67
85
  * operation.</p>
68
86
  *
87
+ * @throws {@link CognitoIdentityProviderServiceException}
88
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
69
89
  *
70
90
  */
71
91
  export declare class CreateUserImportJobCommand extends $Command<CreateUserImportJobCommandInput, CreateUserImportJobCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -80,6 +80,62 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
80
80
  * };
81
81
  * const command = new CreateUserPoolClientCommand(input);
82
82
  * const response = await client.send(command);
83
+ * // { // CreateUserPoolClientResponse
84
+ * // UserPoolClient: { // UserPoolClientType
85
+ * // UserPoolId: "STRING_VALUE",
86
+ * // ClientName: "STRING_VALUE",
87
+ * // ClientId: "STRING_VALUE",
88
+ * // ClientSecret: "STRING_VALUE",
89
+ * // LastModifiedDate: new Date("TIMESTAMP"),
90
+ * // CreationDate: new Date("TIMESTAMP"),
91
+ * // RefreshTokenValidity: Number("int"),
92
+ * // AccessTokenValidity: Number("int"),
93
+ * // IdTokenValidity: Number("int"),
94
+ * // TokenValidityUnits: { // TokenValidityUnitsType
95
+ * // AccessToken: "seconds" || "minutes" || "hours" || "days",
96
+ * // IdToken: "seconds" || "minutes" || "hours" || "days",
97
+ * // RefreshToken: "seconds" || "minutes" || "hours" || "days",
98
+ * // },
99
+ * // ReadAttributes: [ // ClientPermissionListType
100
+ * // "STRING_VALUE",
101
+ * // ],
102
+ * // WriteAttributes: [
103
+ * // "STRING_VALUE",
104
+ * // ],
105
+ * // ExplicitAuthFlows: [ // ExplicitAuthFlowsListType
106
+ * // "ADMIN_NO_SRP_AUTH" || "CUSTOM_AUTH_FLOW_ONLY" || "USER_PASSWORD_AUTH" || "ALLOW_ADMIN_USER_PASSWORD_AUTH" || "ALLOW_CUSTOM_AUTH" || "ALLOW_USER_PASSWORD_AUTH" || "ALLOW_USER_SRP_AUTH" || "ALLOW_REFRESH_TOKEN_AUTH",
107
+ * // ],
108
+ * // SupportedIdentityProviders: [ // SupportedIdentityProvidersListType
109
+ * // "STRING_VALUE",
110
+ * // ],
111
+ * // CallbackURLs: [ // CallbackURLsListType
112
+ * // "STRING_VALUE",
113
+ * // ],
114
+ * // LogoutURLs: [ // LogoutURLsListType
115
+ * // "STRING_VALUE",
116
+ * // ],
117
+ * // DefaultRedirectURI: "STRING_VALUE",
118
+ * // AllowedOAuthFlows: [ // OAuthFlowsType
119
+ * // "code" || "implicit" || "client_credentials",
120
+ * // ],
121
+ * // AllowedOAuthScopes: [ // ScopeListType
122
+ * // "STRING_VALUE",
123
+ * // ],
124
+ * // AllowedOAuthFlowsUserPoolClient: true || false,
125
+ * // AnalyticsConfiguration: { // AnalyticsConfigurationType
126
+ * // ApplicationId: "STRING_VALUE",
127
+ * // ApplicationArn: "STRING_VALUE",
128
+ * // RoleArn: "STRING_VALUE",
129
+ * // ExternalId: "STRING_VALUE",
130
+ * // UserDataShared: true || false,
131
+ * // },
132
+ * // PreventUserExistenceErrors: "LEGACY" || "ENABLED",
133
+ * // EnableTokenRevocation: true || false,
134
+ * // EnablePropagateAdditionalUserContextData: true || false,
135
+ * // AuthSessionValidity: Number("int"),
136
+ * // },
137
+ * // };
138
+ *
83
139
  * ```
84
140
  *
85
141
  * @param CreateUserPoolClientCommandInput - {@link CreateUserPoolClientCommandInput}
@@ -116,6 +172,8 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
116
172
  * <p>This exception is thrown when the user has made too many requests for a given
117
173
  * operation.</p>
118
174
  *
175
+ * @throws {@link CognitoIdentityProviderServiceException}
176
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
119
177
  *
120
178
  */
121
179
  export declare class CreateUserPoolClientCommand extends $Command<CreateUserPoolClientCommandInput, CreateUserPoolClientCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -168,6 +168,140 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
168
168
  * };
169
169
  * const command = new CreateUserPoolCommand(input);
170
170
  * const response = await client.send(command);
171
+ * // { // CreateUserPoolResponse
172
+ * // UserPool: { // UserPoolType
173
+ * // Id: "STRING_VALUE",
174
+ * // Name: "STRING_VALUE",
175
+ * // Policies: { // UserPoolPolicyType
176
+ * // PasswordPolicy: { // PasswordPolicyType
177
+ * // MinimumLength: Number("int"),
178
+ * // RequireUppercase: true || false,
179
+ * // RequireLowercase: true || false,
180
+ * // RequireNumbers: true || false,
181
+ * // RequireSymbols: true || false,
182
+ * // TemporaryPasswordValidityDays: Number("int"),
183
+ * // },
184
+ * // },
185
+ * // DeletionProtection: "ACTIVE" || "INACTIVE",
186
+ * // LambdaConfig: { // LambdaConfigType
187
+ * // PreSignUp: "STRING_VALUE",
188
+ * // CustomMessage: "STRING_VALUE",
189
+ * // PostConfirmation: "STRING_VALUE",
190
+ * // PreAuthentication: "STRING_VALUE",
191
+ * // PostAuthentication: "STRING_VALUE",
192
+ * // DefineAuthChallenge: "STRING_VALUE",
193
+ * // CreateAuthChallenge: "STRING_VALUE",
194
+ * // VerifyAuthChallengeResponse: "STRING_VALUE",
195
+ * // PreTokenGeneration: "STRING_VALUE",
196
+ * // UserMigration: "STRING_VALUE",
197
+ * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
198
+ * // LambdaVersion: "V1_0", // required
199
+ * // LambdaArn: "STRING_VALUE", // required
200
+ * // },
201
+ * // CustomEmailSender: { // CustomEmailLambdaVersionConfigType
202
+ * // LambdaVersion: "V1_0", // required
203
+ * // LambdaArn: "STRING_VALUE", // required
204
+ * // },
205
+ * // KMSKeyID: "STRING_VALUE",
206
+ * // },
207
+ * // Status: "Enabled" || "Disabled",
208
+ * // LastModifiedDate: new Date("TIMESTAMP"),
209
+ * // CreationDate: new Date("TIMESTAMP"),
210
+ * // SchemaAttributes: [ // SchemaAttributesListType
211
+ * // { // SchemaAttributeType
212
+ * // Name: "STRING_VALUE",
213
+ * // AttributeDataType: "String" || "Number" || "DateTime" || "Boolean",
214
+ * // DeveloperOnlyAttribute: true || false,
215
+ * // Mutable: true || false,
216
+ * // Required: true || false,
217
+ * // NumberAttributeConstraints: { // NumberAttributeConstraintsType
218
+ * // MinValue: "STRING_VALUE",
219
+ * // MaxValue: "STRING_VALUE",
220
+ * // },
221
+ * // StringAttributeConstraints: { // StringAttributeConstraintsType
222
+ * // MinLength: "STRING_VALUE",
223
+ * // MaxLength: "STRING_VALUE",
224
+ * // },
225
+ * // },
226
+ * // ],
227
+ * // AutoVerifiedAttributes: [ // VerifiedAttributesListType
228
+ * // "phone_number" || "email",
229
+ * // ],
230
+ * // AliasAttributes: [ // AliasAttributesListType
231
+ * // "phone_number" || "email" || "preferred_username",
232
+ * // ],
233
+ * // UsernameAttributes: [ // UsernameAttributesListType
234
+ * // "phone_number" || "email",
235
+ * // ],
236
+ * // SmsVerificationMessage: "STRING_VALUE",
237
+ * // EmailVerificationMessage: "STRING_VALUE",
238
+ * // EmailVerificationSubject: "STRING_VALUE",
239
+ * // VerificationMessageTemplate: { // VerificationMessageTemplateType
240
+ * // SmsMessage: "STRING_VALUE",
241
+ * // EmailMessage: "STRING_VALUE",
242
+ * // EmailSubject: "STRING_VALUE",
243
+ * // EmailMessageByLink: "STRING_VALUE",
244
+ * // EmailSubjectByLink: "STRING_VALUE",
245
+ * // DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE",
246
+ * // },
247
+ * // SmsAuthenticationMessage: "STRING_VALUE",
248
+ * // UserAttributeUpdateSettings: { // UserAttributeUpdateSettingsType
249
+ * // AttributesRequireVerificationBeforeUpdate: [ // AttributesRequireVerificationBeforeUpdateType
250
+ * // "phone_number" || "email",
251
+ * // ],
252
+ * // },
253
+ * // MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
254
+ * // DeviceConfiguration: { // DeviceConfigurationType
255
+ * // ChallengeRequiredOnNewDevice: true || false,
256
+ * // DeviceOnlyRememberedOnUserPrompt: true || false,
257
+ * // },
258
+ * // EstimatedNumberOfUsers: Number("int"),
259
+ * // EmailConfiguration: { // EmailConfigurationType
260
+ * // SourceArn: "STRING_VALUE",
261
+ * // ReplyToEmailAddress: "STRING_VALUE",
262
+ * // EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER",
263
+ * // From: "STRING_VALUE",
264
+ * // ConfigurationSet: "STRING_VALUE",
265
+ * // },
266
+ * // SmsConfiguration: { // SmsConfigurationType
267
+ * // SnsCallerArn: "STRING_VALUE", // required
268
+ * // ExternalId: "STRING_VALUE",
269
+ * // SnsRegion: "STRING_VALUE",
270
+ * // },
271
+ * // UserPoolTags: { // UserPoolTagsType
272
+ * // "<keys>": "STRING_VALUE",
273
+ * // },
274
+ * // SmsConfigurationFailure: "STRING_VALUE",
275
+ * // EmailConfigurationFailure: "STRING_VALUE",
276
+ * // Domain: "STRING_VALUE",
277
+ * // CustomDomain: "STRING_VALUE",
278
+ * // AdminCreateUserConfig: { // AdminCreateUserConfigType
279
+ * // AllowAdminCreateUserOnly: true || false,
280
+ * // UnusedAccountValidityDays: Number("int"),
281
+ * // InviteMessageTemplate: { // MessageTemplateType
282
+ * // SMSMessage: "STRING_VALUE",
283
+ * // EmailMessage: "STRING_VALUE",
284
+ * // EmailSubject: "STRING_VALUE",
285
+ * // },
286
+ * // },
287
+ * // UserPoolAddOns: { // UserPoolAddOnsType
288
+ * // AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required
289
+ * // },
290
+ * // UsernameConfiguration: { // UsernameConfigurationType
291
+ * // CaseSensitive: true || false, // required
292
+ * // },
293
+ * // Arn: "STRING_VALUE",
294
+ * // AccountRecoverySetting: { // AccountRecoverySettingType
295
+ * // RecoveryMechanisms: [ // RecoveryMechanismsType
296
+ * // { // RecoveryOptionType
297
+ * // Priority: Number("int"), // required
298
+ * // Name: "verified_email" || "verified_phone_number" || "admin_only", // required
299
+ * // },
300
+ * // ],
301
+ * // },
302
+ * // },
303
+ * // };
304
+ *
171
305
  * ```
172
306
  *
173
307
  * @param CreateUserPoolCommandInput - {@link CreateUserPoolCommandInput}
@@ -211,6 +345,8 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
211
345
  * @throws {@link UserPoolTaggingException} (client fault)
212
346
  * <p>This exception is thrown when a user pool tag can't be set or updated.</p>
213
347
  *
348
+ * @throws {@link CognitoIdentityProviderServiceException}
349
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
214
350
  *
215
351
  */
216
352
  export declare class CreateUserPoolCommand extends $Command<CreateUserPoolCommandInput, CreateUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface CreateUserPoolDomainCommandOutput extends CreateUserPoolDomainR
35
35
  * };
36
36
  * const command = new CreateUserPoolDomainCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // CreateUserPoolDomainResponse
39
+ * // CloudFrontDomain: "STRING_VALUE",
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param CreateUserPoolDomainCommandInput - {@link CreateUserPoolDomainCommandInput}
@@ -61,6 +65,8 @@ export interface CreateUserPoolDomainCommandOutput extends CreateUserPoolDomainR
61
65
  * <p>This exception is thrown when the Amazon Cognito service can't find the requested
62
66
  * resource.</p>
63
67
  *
68
+ * @throws {@link CognitoIdentityProviderServiceException}
69
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
64
70
  *
65
71
  */
66
72
  export declare class CreateUserPoolDomainCommand extends $Command<CreateUserPoolDomainCommandInput, CreateUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteGroupCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
@@ -59,6 +61,8 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {
59
61
  * <p>This exception is thrown when the user has made too many requests for a given
60
62
  * operation.</p>
61
63
  *
64
+ * @throws {@link CognitoIdentityProviderServiceException}
65
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
62
66
  *
63
67
  */
64
68
  export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteIdentityProviderCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteIdentityProviderCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteIdentityProviderCommandInput - {@link DeleteIdentityProviderCommandInput}
@@ -65,6 +67,8 @@ export interface DeleteIdentityProviderCommandOutput extends __MetadataBearer {
65
67
  * @throws {@link UnsupportedIdentityProviderException} (client fault)
66
68
  * <p>This exception is thrown when the specified identifier isn't supported.</p>
67
69
  *
70
+ * @throws {@link CognitoIdentityProviderServiceException}
71
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
68
72
  *
69
73
  */
70
74
  export declare class DeleteIdentityProviderCommand extends $Command<DeleteIdentityProviderCommandInput, DeleteIdentityProviderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteResourceServerCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteResourceServerCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteResourceServerCommandInput - {@link DeleteResourceServerCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteResourceServerCommandOutput extends __MetadataBearer {
58
60
  * <p>This exception is thrown when the user has made too many requests for a given
59
61
  * operation.</p>
60
62
  *
63
+ * @throws {@link CognitoIdentityProviderServiceException}
64
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeleteResourceServerCommand extends $Command<DeleteResourceServerCommandInput, DeleteResourceServerCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteUserAttributesCommandOutput extends DeleteUserAttributesR
34
34
  * };
35
35
  * const command = new DeleteUserAttributesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteUserAttributesCommandInput - {@link DeleteUserAttributesCommandInput}
@@ -72,6 +74,8 @@ export interface DeleteUserAttributesCommandOutput extends DeleteUserAttributesR
72
74
  * @throws {@link UserNotFoundException} (client fault)
73
75
  * <p>This exception is thrown when a user isn't found.</p>
74
76
  *
77
+ * @throws {@link CognitoIdentityProviderServiceException}
78
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
75
79
  *
76
80
  */
77
81
  export declare class DeleteUserAttributesCommand extends $Command<DeleteUserAttributesCommandInput, DeleteUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteUserCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
@@ -69,6 +71,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
69
71
  * @throws {@link UserNotFoundException} (client fault)
70
72
  * <p>This exception is thrown when a user isn't found.</p>
71
73
  *
74
+ * @throws {@link CognitoIdentityProviderServiceException}
75
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
72
76
  *
73
77
  */
74
78
  export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteUserPoolClientCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteUserPoolClientCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteUserPoolClientCommandInput - {@link DeleteUserPoolClientCommandInput}
@@ -62,6 +64,8 @@ export interface DeleteUserPoolClientCommandOutput extends __MetadataBearer {
62
64
  * <p>This exception is thrown when the user has made too many requests for a given
63
65
  * operation.</p>
64
66
  *
67
+ * @throws {@link CognitoIdentityProviderServiceException}
68
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
65
69
  *
66
70
  */
67
71
  export declare class DeleteUserPoolClientCommand extends $Command<DeleteUserPoolClientCommandInput, DeleteUserPoolClientCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteUserPoolCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteUserPoolCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteUserPoolCommandInput - {@link DeleteUserPoolCommandInput}
@@ -61,6 +63,8 @@ export interface DeleteUserPoolCommandOutput extends __MetadataBearer {
61
63
  * <p>This exception is thrown when you're trying to modify a user pool while a user import
62
64
  * job is in progress for that pool.</p>
63
65
  *
66
+ * @throws {@link CognitoIdentityProviderServiceException}
67
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
64
68
  *
65
69
  */
66
70
  export declare class DeleteUserPoolCommand extends $Command<DeleteUserPoolCommandInput, DeleteUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteUserPoolDomainCommandOutput extends DeleteUserPoolDomainR
32
32
  * };
33
33
  * const command = new DeleteUserPoolDomainCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteUserPoolDomainCommandInput - {@link DeleteUserPoolDomainCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteUserPoolDomainCommandOutput extends DeleteUserPoolDomainR
54
56
  * <p>This exception is thrown when the Amazon Cognito service can't find the requested
55
57
  * resource.</p>
56
58
  *
59
+ * @throws {@link CognitoIdentityProviderServiceException}
60
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteUserPoolDomainCommand extends $Command<DeleteUserPoolDomainCommandInput, DeleteUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {