cognitoidentityserviceprovider.d.ts (96989B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class CognitoIdentityServiceProvider extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: CognitoIdentityServiceProvider.Types.ClientConfiguration) 13 config: Config & CognitoIdentityServiceProvider.Types.ClientConfiguration; 14 /** 15 * Adds additional user attributes to the user pool schema. 16 */ 17 addCustomAttributes(params: CognitoIdentityServiceProvider.Types.AddCustomAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse, AWSError>; 18 /** 19 * Adds additional user attributes to the user pool schema. 20 */ 21 addCustomAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse, AWSError>; 22 /** 23 * Confirms user registration as an admin without using a confirmation code. Works on any user. 24 */ 25 adminConfirmSignUp(params: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse, AWSError>; 26 /** 27 * Confirms user registration as an admin without using a confirmation code. Works on any user. 28 */ 29 adminConfirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse, AWSError>; 30 /** 31 * Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password. Requires developer credentials. 32 */ 33 adminCreateUser(params: CognitoIdentityServiceProvider.Types.AdminCreateUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminCreateUserResponse, AWSError>; 34 /** 35 * Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password. Requires developer credentials. 36 */ 37 adminCreateUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminCreateUserResponse, AWSError>; 38 /** 39 * Deletes a user as an administrator. Works on any user. 40 */ 41 adminDeleteUser(params: CognitoIdentityServiceProvider.Types.AdminDeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 42 /** 43 * Deletes a user as an administrator. Works on any user. 44 */ 45 adminDeleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 46 /** 47 * Deletes the user attributes in a user pool as an administrator. Works on any user. 48 */ 49 adminDeleteUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse, AWSError>; 50 /** 51 * Deletes the user attributes in a user pool as an administrator. Works on any user. 52 */ 53 adminDeleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse, AWSError>; 54 /** 55 * Disables the specified user as an administrator. Works on any user. 56 */ 57 adminDisableUser(params: CognitoIdentityServiceProvider.Types.AdminDisableUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableUserResponse, AWSError>; 58 /** 59 * Disables the specified user as an administrator. Works on any user. 60 */ 61 adminDisableUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableUserResponse, AWSError>; 62 /** 63 * Enables the specified user as an administrator. Works on any user. 64 */ 65 adminEnableUser(params: CognitoIdentityServiceProvider.Types.AdminEnableUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminEnableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminEnableUserResponse, AWSError>; 66 /** 67 * Enables the specified user as an administrator. Works on any user. 68 */ 69 adminEnableUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminEnableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminEnableUserResponse, AWSError>; 70 /** 71 * Forgets the device, as an administrator. 72 */ 73 adminForgetDevice(params: CognitoIdentityServiceProvider.Types.AdminForgetDeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 74 /** 75 * Forgets the device, as an administrator. 76 */ 77 adminForgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 78 /** 79 * Gets the device, as an administrator. 80 */ 81 adminGetDevice(params: CognitoIdentityServiceProvider.Types.AdminGetDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse, AWSError>; 82 /** 83 * Gets the device, as an administrator. 84 */ 85 adminGetDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse, AWSError>; 86 /** 87 * Gets the specified user by user name in a user pool as an administrator. Works on any user. 88 */ 89 adminGetUser(params: CognitoIdentityServiceProvider.Types.AdminGetUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetUserResponse, AWSError>; 90 /** 91 * Gets the specified user by user name in a user pool as an administrator. Works on any user. 92 */ 93 adminGetUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetUserResponse, AWSError>; 94 /** 95 * Initiates the authentication flow, as an administrator. 96 */ 97 adminInitiateAuth(params: CognitoIdentityServiceProvider.Types.AdminInitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse, AWSError>; 98 /** 99 * Initiates the authentication flow, as an administrator. 100 */ 101 adminInitiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse, AWSError>; 102 /** 103 * Lists devices, as an administrator. 104 */ 105 adminListDevices(params: CognitoIdentityServiceProvider.Types.AdminListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListDevicesResponse, AWSError>; 106 /** 107 * Lists devices, as an administrator. 108 */ 109 adminListDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListDevicesResponse, AWSError>; 110 /** 111 * Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. 112 */ 113 adminResetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse, AWSError>; 114 /** 115 * Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. 116 */ 117 adminResetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse, AWSError>; 118 /** 119 * Responds to an authentication challenge, as an administrator. 120 */ 121 adminRespondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse, AWSError>; 122 /** 123 * Responds to an authentication challenge, as an administrator. 124 */ 125 adminRespondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse, AWSError>; 126 /** 127 * Sets all the user settings for a specified user name. Works on any user. 128 */ 129 adminSetUserSettings(params: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse, AWSError>; 130 /** 131 * Sets all the user settings for a specified user name. Works on any user. 132 */ 133 adminSetUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse, AWSError>; 134 /** 135 * Updates the device status as an administrator. 136 */ 137 adminUpdateDeviceStatus(params: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse, AWSError>; 138 /** 139 * Updates the device status as an administrator. 140 */ 141 adminUpdateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse, AWSError>; 142 /** 143 * Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. 144 */ 145 adminUpdateUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse, AWSError>; 146 /** 147 * Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. 148 */ 149 adminUpdateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse, AWSError>; 150 /** 151 * Signs out users from all devices, as an administrator. 152 */ 153 adminUserGlobalSignOut(params: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse, AWSError>; 154 /** 155 * Signs out users from all devices, as an administrator. 156 */ 157 adminUserGlobalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse, AWSError>; 158 /** 159 * Changes the password for a specified user in a user pool. 160 */ 161 changePassword(params: CognitoIdentityServiceProvider.Types.ChangePasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ChangePasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ChangePasswordResponse, AWSError>; 162 /** 163 * Changes the password for a specified user in a user pool. 164 */ 165 changePassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ChangePasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ChangePasswordResponse, AWSError>; 166 /** 167 * Confirms tracking of the device. This API call is the call that beings device tracking. 168 */ 169 confirmDevice(params: CognitoIdentityServiceProvider.Types.ConfirmDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse, AWSError>; 170 /** 171 * Confirms tracking of the device. This API call is the call that beings device tracking. 172 */ 173 confirmDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse, AWSError>; 174 /** 175 * Allows a user to enter a code provided when they reset their password to update their password. 176 */ 177 confirmForgotPassword(params: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse, AWSError>; 178 /** 179 * Allows a user to enter a code provided when they reset their password to update their password. 180 */ 181 confirmForgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse, AWSError>; 182 /** 183 * Confirms registration of a user and handles the existing alias from a previous user. 184 */ 185 confirmSignUp(params: CognitoIdentityServiceProvider.Types.ConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse, AWSError>; 186 /** 187 * Confirms registration of a user and handles the existing alias from a previous user. 188 */ 189 confirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse, AWSError>; 190 /** 191 * Creates the user import job. 192 */ 193 createUserImportJob(params: CognitoIdentityServiceProvider.Types.CreateUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse, AWSError>; 194 /** 195 * Creates the user import job. 196 */ 197 createUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse, AWSError>; 198 /** 199 * Creates a new Amazon Cognito user pool and sets the password policy for the pool. 200 */ 201 createUserPool(params: CognitoIdentityServiceProvider.Types.CreateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolResponse, AWSError>; 202 /** 203 * Creates a new Amazon Cognito user pool and sets the password policy for the pool. 204 */ 205 createUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolResponse, AWSError>; 206 /** 207 * Creates the user pool client. 208 */ 209 createUserPoolClient(params: CognitoIdentityServiceProvider.Types.CreateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse, AWSError>; 210 /** 211 * Creates the user pool client. 212 */ 213 createUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse, AWSError>; 214 /** 215 * Allows a user to delete one's self. 216 */ 217 deleteUser(params: CognitoIdentityServiceProvider.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 218 /** 219 * Allows a user to delete one's self. 220 */ 221 deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 222 /** 223 * Deletes the attributes for a user. 224 */ 225 deleteUserAttributes(params: CognitoIdentityServiceProvider.Types.DeleteUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse, AWSError>; 226 /** 227 * Deletes the attributes for a user. 228 */ 229 deleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse, AWSError>; 230 /** 231 * Deletes the specified Amazon Cognito user pool. 232 */ 233 deleteUserPool(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 234 /** 235 * Deletes the specified Amazon Cognito user pool. 236 */ 237 deleteUserPool(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 238 /** 239 * Allows the developer to delete the user pool client. 240 */ 241 deleteUserPoolClient(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolClientRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 242 /** 243 * Allows the developer to delete the user pool client. 244 */ 245 deleteUserPoolClient(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 246 /** 247 * Describes the user import job. 248 */ 249 describeUserImportJob(params: CognitoIdentityServiceProvider.Types.DescribeUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse, AWSError>; 250 /** 251 * Describes the user import job. 252 */ 253 describeUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse, AWSError>; 254 /** 255 * Returns the configuration information and metadata of the specified user pool. 256 */ 257 describeUserPool(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse, AWSError>; 258 /** 259 * Returns the configuration information and metadata of the specified user pool. 260 */ 261 describeUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse, AWSError>; 262 /** 263 * Client method for returning the configuration information and metadata of the specified user pool client. 264 */ 265 describeUserPoolClient(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse, AWSError>; 266 /** 267 * Client method for returning the configuration information and metadata of the specified user pool client. 268 */ 269 describeUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse, AWSError>; 270 /** 271 * Forgets the specified device. 272 */ 273 forgetDevice(params: CognitoIdentityServiceProvider.Types.ForgetDeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 274 /** 275 * Forgets the specified device. 276 */ 277 forgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 278 /** 279 * Retrieves the password for the specified client ID or username. 280 */ 281 forgotPassword(params: CognitoIdentityServiceProvider.Types.ForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ForgotPasswordResponse, AWSError>; 282 /** 283 * Retrieves the password for the specified client ID or username. 284 */ 285 forgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ForgotPasswordResponse, AWSError>; 286 /** 287 * Gets the header information for the .csv file to be used as input for the user import job. 288 */ 289 getCSVHeader(params: CognitoIdentityServiceProvider.Types.GetCSVHeaderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse, AWSError>; 290 /** 291 * Gets the header information for the .csv file to be used as input for the user import job. 292 */ 293 getCSVHeader(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse, AWSError>; 294 /** 295 * Gets the device. 296 */ 297 getDevice(params: CognitoIdentityServiceProvider.Types.GetDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetDeviceResponse, AWSError>; 298 /** 299 * Gets the device. 300 */ 301 getDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetDeviceResponse, AWSError>; 302 /** 303 * Gets the user attributes and metadata for a user. 304 */ 305 getUser(params: CognitoIdentityServiceProvider.Types.GetUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserResponse, AWSError>; 306 /** 307 * Gets the user attributes and metadata for a user. 308 */ 309 getUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserResponse, AWSError>; 310 /** 311 * Gets the user attribute verification code for the specified attribute name. 312 */ 313 getUserAttributeVerificationCode(params: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>; 314 /** 315 * Gets the user attribute verification code for the specified attribute name. 316 */ 317 getUserAttributeVerificationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>; 318 /** 319 * Signs out users from all devices. 320 */ 321 globalSignOut(params: CognitoIdentityServiceProvider.Types.GlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.GlobalSignOutResponse, AWSError>; 322 /** 323 * Signs out users from all devices. 324 */ 325 globalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.GlobalSignOutResponse, AWSError>; 326 /** 327 * Initiates the authentication flow. 328 */ 329 initiateAuth(params: CognitoIdentityServiceProvider.Types.InitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>; 330 /** 331 * Initiates the authentication flow. 332 */ 333 initiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>; 334 /** 335 * Lists the devices. 336 */ 337 listDevices(params: CognitoIdentityServiceProvider.Types.ListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListDevicesResponse, AWSError>; 338 /** 339 * Lists the devices. 340 */ 341 listDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListDevicesResponse, AWSError>; 342 /** 343 * Lists the user import jobs. 344 */ 345 listUserImportJobs(params: CognitoIdentityServiceProvider.Types.ListUserImportJobsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse, AWSError>; 346 /** 347 * Lists the user import jobs. 348 */ 349 listUserImportJobs(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse, AWSError>; 350 /** 351 * Lists the clients that have been created for the specified user pool. 352 */ 353 listUserPoolClients(params: CognitoIdentityServiceProvider.Types.ListUserPoolClientsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse, AWSError>; 354 /** 355 * Lists the clients that have been created for the specified user pool. 356 */ 357 listUserPoolClients(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse, AWSError>; 358 /** 359 * Lists the user pools associated with an AWS account. 360 */ 361 listUserPools(params: CognitoIdentityServiceProvider.Types.ListUserPoolsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolsResponse, AWSError>; 362 /** 363 * Lists the user pools associated with an AWS account. 364 */ 365 listUserPools(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolsResponse, AWSError>; 366 /** 367 * Lists the users in the Amazon Cognito user pool. 368 */ 369 listUsers(params: CognitoIdentityServiceProvider.Types.ListUsersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersResponse, AWSError>; 370 /** 371 * Lists the users in the Amazon Cognito user pool. 372 */ 373 listUsers(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersResponse, AWSError>; 374 /** 375 * Resends the confirmation (for confirmation of registration) to a specific user in the user pool. 376 */ 377 resendConfirmationCode(params: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse, AWSError>; 378 /** 379 * Resends the confirmation (for confirmation of registration) to a specific user in the user pool. 380 */ 381 resendConfirmationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse, AWSError>; 382 /** 383 * Responds to the authentication challenge. 384 */ 385 respondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse, AWSError>; 386 /** 387 * Responds to the authentication challenge. 388 */ 389 respondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse, AWSError>; 390 /** 391 * Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed. 392 */ 393 setUserSettings(params: CognitoIdentityServiceProvider.Types.SetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserSettingsResponse, AWSError>; 394 /** 395 * Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed. 396 */ 397 setUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserSettingsResponse, AWSError>; 398 /** 399 * Registers the user in the specified user pool and creates a user name, password, and user attributes. 400 */ 401 signUp(params: CognitoIdentityServiceProvider.Types.SignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.SignUpResponse, AWSError>; 402 /** 403 * Registers the user in the specified user pool and creates a user name, password, and user attributes. 404 */ 405 signUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.SignUpResponse, AWSError>; 406 /** 407 * Starts the user import. 408 */ 409 startUserImportJob(params: CognitoIdentityServiceProvider.Types.StartUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StartUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StartUserImportJobResponse, AWSError>; 410 /** 411 * Starts the user import. 412 */ 413 startUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StartUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StartUserImportJobResponse, AWSError>; 414 /** 415 * Stops the user import job. 416 */ 417 stopUserImportJob(params: CognitoIdentityServiceProvider.Types.StopUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StopUserImportJobResponse, AWSError>; 418 /** 419 * Stops the user import job. 420 */ 421 stopUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StopUserImportJobResponse, AWSError>; 422 /** 423 * Updates the device status. 424 */ 425 updateDeviceStatus(params: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse, AWSError>; 426 /** 427 * Updates the device status. 428 */ 429 updateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse, AWSError>; 430 /** 431 * Allows a user to update a specific attribute (one at a time). 432 */ 433 updateUserAttributes(params: CognitoIdentityServiceProvider.Types.UpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse, AWSError>; 434 /** 435 * Allows a user to update a specific attribute (one at a time). 436 */ 437 updateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse, AWSError>; 438 /** 439 * Updates the specified user pool with the specified attributes. 440 */ 441 updateUserPool(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse, AWSError>; 442 /** 443 * Updates the specified user pool with the specified attributes. 444 */ 445 updateUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse, AWSError>; 446 /** 447 * Allows the developer to update the specified user pool client and password policy. 448 */ 449 updateUserPoolClient(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse, AWSError>; 450 /** 451 * Allows the developer to update the specified user pool client and password policy. 452 */ 453 updateUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse, AWSError>; 454 /** 455 * Verifies the specified user attributes in the user pool. 456 */ 457 verifyUserAttribute(params: CognitoIdentityServiceProvider.Types.VerifyUserAttributeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse, AWSError>; 458 /** 459 * Verifies the specified user attributes in the user pool. 460 */ 461 verifyUserAttribute(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse, AWSError>; 462 } 463 declare namespace CognitoIdentityServiceProvider.Types { 464 export interface AddCustomAttributesRequest { 465 /** 466 * The user pool ID for the user pool where you want to add custom attributes. 467 */ 468 UserPoolId: UserPoolIdType; 469 /** 470 * An array of custom attributes, such as Mutable and Name. 471 */ 472 CustomAttributes: CustomAttributesListType; 473 } 474 export interface AddCustomAttributesResponse { 475 } 476 export interface AdminConfirmSignUpRequest { 477 /** 478 * The user pool ID for which you want to confirm user registration. 479 */ 480 UserPoolId: UserPoolIdType; 481 /** 482 * The user name for which you want to confirm user registration. 483 */ 484 Username: UsernameType; 485 } 486 export interface AdminConfirmSignUpResponse { 487 } 488 export interface AdminCreateUserConfigType { 489 /** 490 * Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app. 491 */ 492 AllowAdminCreateUserOnly?: BooleanType; 493 /** 494 * The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. 495 */ 496 UnusedAccountValidityDays?: AdminCreateUserUnusedAccountValidityDaysType; 497 /** 498 * The message template to be used for the welcome message to new users. 499 */ 500 InviteMessageTemplate?: MessageTemplateType; 501 } 502 export interface AdminCreateUserRequest { 503 /** 504 * The user pool ID for the user pool where the user will be created. 505 */ 506 UserPoolId: UserPoolIdType; 507 /** 508 * The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed. 509 */ 510 Username: UsernameType; 511 /** 512 * An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools. In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.) email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter. 513 */ 514 UserAttributes?: AttributeListType; 515 /** 516 * The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data is not persisted. 517 */ 518 ValidationData?: AttributeListType; 519 /** 520 * The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins. This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you. The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. 521 */ 522 TemporaryPassword?: PasswordType; 523 /** 524 * This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False. 525 */ 526 ForceAliasCreation?: ForceAliasCreation; 527 /** 528 * Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified. 529 */ 530 MessageAction?: MessageActionType; 531 /** 532 * Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified. 533 */ 534 DesiredDeliveryMediums?: DeliveryMediumListType; 535 } 536 export interface AdminCreateUserResponse { 537 /** 538 * The user returned in the request to create a new user. 539 */ 540 User?: UserType; 541 } 542 export type AdminCreateUserUnusedAccountValidityDaysType = number; 543 export interface AdminDeleteUserAttributesRequest { 544 /** 545 * The user pool ID for the user pool where you want to delete user attributes. 546 */ 547 UserPoolId: UserPoolIdType; 548 /** 549 * The user name of the user from which you would like to delete attributes. 550 */ 551 Username: UsernameType; 552 /** 553 * An array of strings representing the user attribute names you wish to delete. 554 */ 555 UserAttributeNames: AttributeNameListType; 556 } 557 export interface AdminDeleteUserAttributesResponse { 558 } 559 export interface AdminDeleteUserRequest { 560 /** 561 * The user pool ID for the user pool where you want to delete the user. 562 */ 563 UserPoolId: UserPoolIdType; 564 /** 565 * The user name of the user you wish to delete. 566 */ 567 Username: UsernameType; 568 } 569 export interface AdminDisableUserRequest { 570 /** 571 * The user pool ID for the user pool where you want to disable the user. 572 */ 573 UserPoolId: UserPoolIdType; 574 /** 575 * The user name of the user you wish to disable. 576 */ 577 Username: UsernameType; 578 } 579 export interface AdminDisableUserResponse { 580 } 581 export interface AdminEnableUserRequest { 582 /** 583 * The user pool ID for the user pool where you want to enable the user. 584 */ 585 UserPoolId: UserPoolIdType; 586 /** 587 * The user name of the user you wish to ebable. 588 */ 589 Username: UsernameType; 590 } 591 export interface AdminEnableUserResponse { 592 } 593 export interface AdminForgetDeviceRequest { 594 /** 595 * The user pool ID. 596 */ 597 UserPoolId: UserPoolIdType; 598 /** 599 * The user name. 600 */ 601 Username: UsernameType; 602 /** 603 * The device key. 604 */ 605 DeviceKey: DeviceKeyType; 606 } 607 export interface AdminGetDeviceRequest { 608 /** 609 * The device key. 610 */ 611 DeviceKey: DeviceKeyType; 612 /** 613 * The user pool ID. 614 */ 615 UserPoolId: UserPoolIdType; 616 /** 617 * The user name. 618 */ 619 Username: UsernameType; 620 } 621 export interface AdminGetDeviceResponse { 622 /** 623 * The device. 624 */ 625 Device: DeviceType; 626 } 627 export interface AdminGetUserRequest { 628 /** 629 * The user pool ID for the user pool where you want to get information about the user. 630 */ 631 UserPoolId: UserPoolIdType; 632 /** 633 * The user name of the user you wish to retrieve. 634 */ 635 Username: UsernameType; 636 } 637 export interface AdminGetUserResponse { 638 /** 639 * The user name of the user about whom you are receiving information. 640 */ 641 Username: UsernameType; 642 /** 643 * An array of name-value pairs representing user attributes. 644 */ 645 UserAttributes?: AttributeListType; 646 /** 647 * The date the user was created. 648 */ 649 UserCreateDate?: DateType; 650 /** 651 * The date the user was last modified. 652 */ 653 UserLastModifiedDate?: DateType; 654 /** 655 * Indicates that the status is enabled. 656 */ 657 Enabled?: BooleanType; 658 /** 659 * The user status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. COMPROMISED - User is disabled due to a potential security threat. UNKNOWN - User status is not known. 660 */ 661 UserStatus?: UserStatusType; 662 /** 663 * Specifies the options for MFA (e.g., email or phone number). 664 */ 665 MFAOptions?: MFAOptionListType; 666 } 667 export interface AdminInitiateAuthRequest { 668 /** 669 * The ID of the Amazon Cognito user pool. 670 */ 671 UserPoolId: UserPoolIdType; 672 /** 673 * The client app ID. 674 */ 675 ClientId: ClientIdType; 676 /** 677 * The authentication flow. 678 */ 679 AuthFlow: AuthFlowType; 680 /** 681 * The authentication parameters. 682 */ 683 AuthParameters?: AuthParametersType; 684 /** 685 * The client app metadata. 686 */ 687 ClientMetadata?: ClientMetadataType; 688 } 689 export interface AdminInitiateAuthResponse { 690 /** 691 * The name of the challenge. 692 */ 693 ChallengeName?: ChallengeNameType; 694 /** 695 * The session. 696 */ 697 Session?: SessionType; 698 /** 699 * The challenge parameters. 700 */ 701 ChallengeParameters?: ChallengeParametersType; 702 /** 703 * The result of the authentication response. 704 */ 705 AuthenticationResult?: AuthenticationResultType; 706 } 707 export interface AdminListDevicesRequest { 708 /** 709 * The user pool ID. 710 */ 711 UserPoolId: UserPoolIdType; 712 /** 713 * The user name. 714 */ 715 Username: UsernameType; 716 /** 717 * The limit of the devices request. 718 */ 719 Limit?: QueryLimitType; 720 /** 721 * The pagination token. 722 */ 723 PaginationToken?: SearchPaginationTokenType; 724 } 725 export interface AdminListDevicesResponse { 726 /** 727 * The devices in the list of devices response. 728 */ 729 Devices?: DeviceListType; 730 /** 731 * The pagination token. 732 */ 733 PaginationToken?: SearchPaginationTokenType; 734 } 735 export interface AdminResetUserPasswordRequest { 736 /** 737 * The user pool ID for the user pool where you want to reset the user's password. 738 */ 739 UserPoolId: UserPoolIdType; 740 /** 741 * The user name of the user whose password you wish to reset. 742 */ 743 Username: UsernameType; 744 } 745 export interface AdminResetUserPasswordResponse { 746 } 747 export interface AdminRespondToAuthChallengeRequest { 748 /** 749 * The ID of the Amazon Cognito user pool. 750 */ 751 UserPoolId: UserPoolIdType; 752 /** 753 * The client ID. 754 */ 755 ClientId: ClientIdType; 756 /** 757 * The name of the challenge. 758 */ 759 ChallengeName: ChallengeNameType; 760 /** 761 * The challenge response. 762 */ 763 ChallengeResponses?: ChallengeResponsesType; 764 /** 765 * The session. 766 */ 767 Session?: SessionType; 768 } 769 export interface AdminRespondToAuthChallengeResponse { 770 /** 771 * The name of the challenge. 772 */ 773 ChallengeName?: ChallengeNameType; 774 /** 775 * The session. 776 */ 777 Session?: SessionType; 778 /** 779 * The challenge parameters. 780 */ 781 ChallengeParameters?: ChallengeParametersType; 782 /** 783 * The result returned by the server in response to the authentication request. 784 */ 785 AuthenticationResult?: AuthenticationResultType; 786 } 787 export interface AdminSetUserSettingsRequest { 788 /** 789 * The user pool ID for the user pool where you want to set the user's settings, such as MFA options. 790 */ 791 UserPoolId: UserPoolIdType; 792 /** 793 * The user name of the user for whom you wish to set user settings. 794 */ 795 Username: UsernameType; 796 /** 797 * Specifies the options for MFA (e.g., email or phone number). 798 */ 799 MFAOptions: MFAOptionListType; 800 } 801 export interface AdminSetUserSettingsResponse { 802 } 803 export interface AdminUpdateDeviceStatusRequest { 804 /** 805 * The user pool ID> 806 */ 807 UserPoolId: UserPoolIdType; 808 /** 809 * The user name. 810 */ 811 Username: UsernameType; 812 /** 813 * The device key. 814 */ 815 DeviceKey: DeviceKeyType; 816 /** 817 * The status indicating whether a device has been remembered or not. 818 */ 819 DeviceRememberedStatus?: DeviceRememberedStatusType; 820 } 821 export interface AdminUpdateDeviceStatusResponse { 822 } 823 export interface AdminUpdateUserAttributesRequest { 824 /** 825 * The user pool ID for the user pool where you want to update user attributes. 826 */ 827 UserPoolId: UserPoolIdType; 828 /** 829 * The user name of the user for whom you want to update user attributes. 830 */ 831 Username: UsernameType; 832 /** 833 * An array of name-value pairs representing user attributes. 834 */ 835 UserAttributes: AttributeListType; 836 } 837 export interface AdminUpdateUserAttributesResponse { 838 } 839 export interface AdminUserGlobalSignOutRequest { 840 /** 841 * The user pool ID. 842 */ 843 UserPoolId: UserPoolIdType; 844 /** 845 * The user name. 846 */ 847 Username: UsernameType; 848 } 849 export interface AdminUserGlobalSignOutResponse { 850 } 851 export type AliasAttributeType = "phone_number"|"email"|"preferred_username"|string; 852 export type AliasAttributesListType = AliasAttributeType[]; 853 export type ArnType = string; 854 export type AttributeDataType = "String"|"Number"|"DateTime"|"Boolean"|string; 855 export type AttributeListType = AttributeType[]; 856 export type AttributeNameListType = AttributeNameType[]; 857 export type AttributeNameType = string; 858 export interface AttributeType { 859 /** 860 * The name of the attribute. 861 */ 862 Name: AttributeNameType; 863 /** 864 * The value of the attribute. 865 */ 866 Value?: AttributeValueType; 867 } 868 export type AttributeValueType = string; 869 export type AuthFlowType = "USER_SRP_AUTH"|"REFRESH_TOKEN_AUTH"|"REFRESH_TOKEN"|"CUSTOM_AUTH"|"ADMIN_NO_SRP_AUTH"|string; 870 export type AuthParametersType = {[key: string]: StringType}; 871 export interface AuthenticationResultType { 872 /** 873 * The access token of the authentication result. 874 */ 875 AccessToken?: TokenModelType; 876 /** 877 * The expiration period of the authentication result. 878 */ 879 ExpiresIn?: IntegerType; 880 /** 881 * The token type of the authentication result. 882 */ 883 TokenType?: StringType; 884 /** 885 * The refresh token of the authentication result. 886 */ 887 RefreshToken?: TokenModelType; 888 /** 889 * The ID token of the authentication result. 890 */ 891 IdToken?: TokenModelType; 892 /** 893 * The new device metadata from an authentication result. 894 */ 895 NewDeviceMetadata?: NewDeviceMetadataType; 896 } 897 export type BooleanType = boolean; 898 export type ChallengeNameType = "SMS_MFA"|"PASSWORD_VERIFIER"|"CUSTOM_CHALLENGE"|"DEVICE_SRP_AUTH"|"DEVICE_PASSWORD_VERIFIER"|"ADMIN_NO_SRP_AUTH"|"NEW_PASSWORD_REQUIRED"|string; 899 export type ChallengeParametersType = {[key: string]: StringType}; 900 export type ChallengeResponsesType = {[key: string]: StringType}; 901 export interface ChangePasswordRequest { 902 /** 903 * The old password in the change password request. 904 */ 905 PreviousPassword: PasswordType; 906 /** 907 * The new password in the change password request. 908 */ 909 ProposedPassword: PasswordType; 910 /** 911 * The access token in the change password request. 912 */ 913 AccessToken?: TokenModelType; 914 } 915 export interface ChangePasswordResponse { 916 } 917 export type ClientIdType = string; 918 export type ClientMetadataType = {[key: string]: StringType}; 919 export type ClientNameType = string; 920 export type ClientPermissionListType = ClientPermissionType[]; 921 export type ClientPermissionType = string; 922 export type ClientSecretType = string; 923 export type CodeDeliveryDetailsListType = CodeDeliveryDetailsType[]; 924 export interface CodeDeliveryDetailsType { 925 /** 926 * The destination for the code delivery details. 927 */ 928 Destination?: StringType; 929 /** 930 * The delivery medium (email message or phone number). 931 */ 932 DeliveryMedium?: DeliveryMediumType; 933 /** 934 * The name of the attribute in the code delivery details type. 935 */ 936 AttributeName?: AttributeNameType; 937 } 938 export type CompletionMessageType = string; 939 export interface ConfirmDeviceRequest { 940 /** 941 * The access token. 942 */ 943 AccessToken: TokenModelType; 944 /** 945 * The device key. 946 */ 947 DeviceKey: DeviceKeyType; 948 /** 949 * The configuration of the device secret verifier. 950 */ 951 DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType; 952 /** 953 * The device name. 954 */ 955 DeviceName?: DeviceNameType; 956 } 957 export interface ConfirmDeviceResponse { 958 /** 959 * Indicates whether the user confirmation is necessary to confirm the device response. 960 */ 961 UserConfirmationNecessary?: BooleanType; 962 } 963 export interface ConfirmForgotPasswordRequest { 964 /** 965 * The ID of the client associated with the user pool. 966 */ 967 ClientId: ClientIdType; 968 /** 969 * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. 970 */ 971 SecretHash?: SecretHashType; 972 /** 973 * The user name of the user for whom you want to enter a code to retrieve a forgotten password. 974 */ 975 Username: UsernameType; 976 /** 977 * The confirmation code sent by a user's request to retrieve a forgotten password. 978 */ 979 ConfirmationCode: ConfirmationCodeType; 980 /** 981 * The password sent by sent by a user's request to retrieve a forgotten password. 982 */ 983 Password: PasswordType; 984 } 985 export interface ConfirmForgotPasswordResponse { 986 } 987 export interface ConfirmSignUpRequest { 988 /** 989 * The ID of the client associated with the user pool. 990 */ 991 ClientId: ClientIdType; 992 /** 993 * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. 994 */ 995 SecretHash?: SecretHashType; 996 /** 997 * The user name of the user whose registration you wish to confirm. 998 */ 999 Username: UsernameType; 1000 /** 1001 * The confirmation code sent by a user's request to confirm registration. 1002 */ 1003 ConfirmationCode: ConfirmationCodeType; 1004 /** 1005 * Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error. 1006 */ 1007 ForceAliasCreation?: ForceAliasCreation; 1008 } 1009 export interface ConfirmSignUpResponse { 1010 } 1011 export type ConfirmationCodeType = string; 1012 export interface CreateUserImportJobRequest { 1013 /** 1014 * The job name for the user import job. 1015 */ 1016 JobName: UserImportJobNameType; 1017 /** 1018 * The user pool ID for the user pool that the users are being imported into. 1019 */ 1020 UserPoolId: UserPoolIdType; 1021 /** 1022 * The role ARN for the Amazon CloudWatch Logging role for the user import job. 1023 */ 1024 CloudWatchLogsRoleArn: ArnType; 1025 } 1026 export interface CreateUserImportJobResponse { 1027 /** 1028 * The job object that represents the user import job. 1029 */ 1030 UserImportJob?: UserImportJobType; 1031 } 1032 export interface CreateUserPoolClientRequest { 1033 /** 1034 * The user pool ID for the user pool where you want to create a user pool client. 1035 */ 1036 UserPoolId: UserPoolIdType; 1037 /** 1038 * The client name for the user pool client you would like to create. 1039 */ 1040 ClientName: ClientNameType; 1041 /** 1042 * Boolean to specify whether you want to generate a secret for the user pool client being created. 1043 */ 1044 GenerateSecret?: GenerateSecret; 1045 /** 1046 * Refreshes the token validity. 1047 */ 1048 RefreshTokenValidity?: RefreshTokenValidityType; 1049 /** 1050 * The read attributes. 1051 */ 1052 ReadAttributes?: ClientPermissionListType; 1053 /** 1054 * The write attributes. 1055 */ 1056 WriteAttributes?: ClientPermissionListType; 1057 /** 1058 * The explicit authentication flows. 1059 */ 1060 ExplicitAuthFlows?: ExplicitAuthFlowsListType; 1061 } 1062 export interface CreateUserPoolClientResponse { 1063 /** 1064 * The user pool client that was just created. 1065 */ 1066 UserPoolClient?: UserPoolClientType; 1067 } 1068 export interface CreateUserPoolRequest { 1069 /** 1070 * A string used to name the user pool. 1071 */ 1072 PoolName: UserPoolNameType; 1073 /** 1074 * The policies associated with the new user pool. 1075 */ 1076 Policies?: UserPoolPolicyType; 1077 /** 1078 * The Lambda trigger configuration information for the new user pool. 1079 */ 1080 LambdaConfig?: LambdaConfigType; 1081 /** 1082 * The attributes to be auto-verified. Possible values: email, phone_number. 1083 */ 1084 AutoVerifiedAttributes?: VerifiedAttributesListType; 1085 /** 1086 * Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. 1087 */ 1088 AliasAttributes?: AliasAttributesListType; 1089 /** 1090 * A string representing the SMS verification message. 1091 */ 1092 SmsVerificationMessage?: SmsVerificationMessageType; 1093 /** 1094 * A string representing the email verification message. 1095 */ 1096 EmailVerificationMessage?: EmailVerificationMessageType; 1097 /** 1098 * A string representing the email verification subject. 1099 */ 1100 EmailVerificationSubject?: EmailVerificationSubjectType; 1101 /** 1102 * A string representing the SMS authentication message. 1103 */ 1104 SmsAuthenticationMessage?: SmsVerificationMessageType; 1105 /** 1106 * Specifies MFA configuration details. 1107 */ 1108 MfaConfiguration?: UserPoolMfaType; 1109 /** 1110 * The device configuration. 1111 */ 1112 DeviceConfiguration?: DeviceConfigurationType; 1113 /** 1114 * The email configuration. 1115 */ 1116 EmailConfiguration?: EmailConfigurationType; 1117 /** 1118 * The SMS configuration. 1119 */ 1120 SmsConfiguration?: SmsConfigurationType; 1121 /** 1122 * The configuration for AdminCreateUser requests. 1123 */ 1124 AdminCreateUserConfig?: AdminCreateUserConfigType; 1125 /** 1126 * An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. 1127 */ 1128 Schema?: SchemaAttributesListType; 1129 } 1130 export interface CreateUserPoolResponse { 1131 /** 1132 * A container for the user pool details. 1133 */ 1134 UserPool?: UserPoolType; 1135 } 1136 export type CustomAttributeNameType = string; 1137 export type CustomAttributesListType = SchemaAttributeType[]; 1138 export type DateType = Date; 1139 export interface DeleteUserAttributesRequest { 1140 /** 1141 * An array of strings representing the user attribute names you wish to delete. 1142 */ 1143 UserAttributeNames: AttributeNameListType; 1144 /** 1145 * The access token used in the request to delete user attributes. 1146 */ 1147 AccessToken?: TokenModelType; 1148 } 1149 export interface DeleteUserAttributesResponse { 1150 } 1151 export interface DeleteUserPoolClientRequest { 1152 /** 1153 * The user pool ID for the user pool where you want to delete the client. 1154 */ 1155 UserPoolId: UserPoolIdType; 1156 /** 1157 * The ID of the client associated with the user pool. 1158 */ 1159 ClientId: ClientIdType; 1160 } 1161 export interface DeleteUserPoolRequest { 1162 /** 1163 * The user pool ID for the user pool you want to delete. 1164 */ 1165 UserPoolId: UserPoolIdType; 1166 } 1167 export interface DeleteUserRequest { 1168 /** 1169 * The access token from a request to delete a user. 1170 */ 1171 AccessToken?: TokenModelType; 1172 } 1173 export type DeliveryMediumListType = DeliveryMediumType[]; 1174 export type DeliveryMediumType = "SMS"|"EMAIL"|string; 1175 export interface DescribeUserImportJobRequest { 1176 /** 1177 * The user pool ID for the user pool that the users are being imported into. 1178 */ 1179 UserPoolId: UserPoolIdType; 1180 /** 1181 * The job ID for the user import job. 1182 */ 1183 JobId: UserImportJobIdType; 1184 } 1185 export interface DescribeUserImportJobResponse { 1186 /** 1187 * The job object that represents the user import job. 1188 */ 1189 UserImportJob?: UserImportJobType; 1190 } 1191 export interface DescribeUserPoolClientRequest { 1192 /** 1193 * The user pool ID for the user pool you want to describe. 1194 */ 1195 UserPoolId: UserPoolIdType; 1196 /** 1197 * The ID of the client associated with the user pool. 1198 */ 1199 ClientId: ClientIdType; 1200 } 1201 export interface DescribeUserPoolClientResponse { 1202 /** 1203 * The user pool client from a server response to describe the user pool client. 1204 */ 1205 UserPoolClient?: UserPoolClientType; 1206 } 1207 export interface DescribeUserPoolRequest { 1208 /** 1209 * The user pool ID for the user pool you want to describe. 1210 */ 1211 UserPoolId: UserPoolIdType; 1212 } 1213 export interface DescribeUserPoolResponse { 1214 /** 1215 * The container of metadata returned by the server to describe the pool. 1216 */ 1217 UserPool?: UserPoolType; 1218 } 1219 export interface DeviceConfigurationType { 1220 /** 1221 * Indicates whether a challenge is required on a new device. Only applicable to a new device. 1222 */ 1223 ChallengeRequiredOnNewDevice?: BooleanType; 1224 /** 1225 * If true, a device is only remembered on user prompt. 1226 */ 1227 DeviceOnlyRememberedOnUserPrompt?: BooleanType; 1228 } 1229 export type DeviceKeyType = string; 1230 export type DeviceListType = DeviceType[]; 1231 export type DeviceNameType = string; 1232 export type DeviceRememberedStatusType = "remembered"|"not_remembered"|string; 1233 export interface DeviceSecretVerifierConfigType { 1234 /** 1235 * The password verifier. 1236 */ 1237 PasswordVerifier?: StringType; 1238 /** 1239 * The salt. 1240 */ 1241 Salt?: StringType; 1242 } 1243 export interface DeviceType { 1244 /** 1245 * The device key. 1246 */ 1247 DeviceKey?: DeviceKeyType; 1248 /** 1249 * The device attributes. 1250 */ 1251 DeviceAttributes?: AttributeListType; 1252 /** 1253 * The creation date of the device. 1254 */ 1255 DeviceCreateDate?: DateType; 1256 /** 1257 * The last modified date of the device. 1258 */ 1259 DeviceLastModifiedDate?: DateType; 1260 /** 1261 * The date in which the device was last authenticated. 1262 */ 1263 DeviceLastAuthenticatedDate?: DateType; 1264 } 1265 export type EmailAddressType = string; 1266 export interface EmailConfigurationType { 1267 /** 1268 * The Amazon Resource Name (ARN) of the email source. 1269 */ 1270 SourceArn?: ArnType; 1271 /** 1272 * The REPLY-TO email address. 1273 */ 1274 ReplyToEmailAddress?: EmailAddressType; 1275 } 1276 export type EmailVerificationMessageType = string; 1277 export type EmailVerificationSubjectType = string; 1278 export type ExplicitAuthFlowsListType = ExplicitAuthFlowsType[]; 1279 export type ExplicitAuthFlowsType = "ADMIN_NO_SRP_AUTH"|"CUSTOM_AUTH_FLOW_ONLY"|string; 1280 export type ForceAliasCreation = boolean; 1281 export interface ForgetDeviceRequest { 1282 /** 1283 * The access token for the forgotten device request. 1284 */ 1285 AccessToken?: TokenModelType; 1286 /** 1287 * The device key. 1288 */ 1289 DeviceKey: DeviceKeyType; 1290 } 1291 export interface ForgotPasswordRequest { 1292 /** 1293 * The ID of the client associated with the user pool. 1294 */ 1295 ClientId: ClientIdType; 1296 /** 1297 * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. 1298 */ 1299 SecretHash?: SecretHashType; 1300 /** 1301 * The user name of the user for whom you want to enter a code to reset a forgotten password. 1302 */ 1303 Username: UsernameType; 1304 } 1305 export interface ForgotPasswordResponse { 1306 /** 1307 * The code delivery details returned by the server in response to the request to reset a password. 1308 */ 1309 CodeDeliveryDetails?: CodeDeliveryDetailsType; 1310 } 1311 export type GenerateSecret = boolean; 1312 export interface GetCSVHeaderRequest { 1313 /** 1314 * The user pool ID for the user pool that the users are to be imported into. 1315 */ 1316 UserPoolId: UserPoolIdType; 1317 } 1318 export interface GetCSVHeaderResponse { 1319 /** 1320 * The user pool ID for the user pool that the users are to be imported into. 1321 */ 1322 UserPoolId?: UserPoolIdType; 1323 /** 1324 * The header information for the .csv file for the user import job. 1325 */ 1326 CSVHeader?: ListOfStringTypes; 1327 } 1328 export interface GetDeviceRequest { 1329 /** 1330 * The device key. 1331 */ 1332 DeviceKey: DeviceKeyType; 1333 /** 1334 * The access token. 1335 */ 1336 AccessToken?: TokenModelType; 1337 } 1338 export interface GetDeviceResponse { 1339 /** 1340 * The device. 1341 */ 1342 Device: DeviceType; 1343 } 1344 export interface GetUserAttributeVerificationCodeRequest { 1345 /** 1346 * The access token returned by the server response to get the user attribute verification code. 1347 */ 1348 AccessToken?: TokenModelType; 1349 /** 1350 * The attribute name returned by the server response to get the user attribute verification code. 1351 */ 1352 AttributeName: AttributeNameType; 1353 } 1354 export interface GetUserAttributeVerificationCodeResponse { 1355 /** 1356 * The code delivery details returned by the server in response to the request to get the user attribute verification code. 1357 */ 1358 CodeDeliveryDetails?: CodeDeliveryDetailsType; 1359 } 1360 export interface GetUserRequest { 1361 /** 1362 * The access token returned by the server response to get information about the user. 1363 */ 1364 AccessToken?: TokenModelType; 1365 } 1366 export interface GetUserResponse { 1367 /** 1368 * The user name of the user you wish to retrieve from the get user request. 1369 */ 1370 Username: UsernameType; 1371 /** 1372 * An array of name-value pairs representing user attributes. 1373 */ 1374 UserAttributes: AttributeListType; 1375 /** 1376 * Specifies the options for MFA (e.g., email or phone number). 1377 */ 1378 MFAOptions?: MFAOptionListType; 1379 } 1380 export interface GlobalSignOutRequest { 1381 /** 1382 * The access token. 1383 */ 1384 AccessToken?: TokenModelType; 1385 } 1386 export interface GlobalSignOutResponse { 1387 } 1388 export interface InitiateAuthRequest { 1389 /** 1390 * The authentication flow. 1391 */ 1392 AuthFlow: AuthFlowType; 1393 /** 1394 * The authentication parameters. 1395 */ 1396 AuthParameters?: AuthParametersType; 1397 /** 1398 * The client app's metadata. 1399 */ 1400 ClientMetadata?: ClientMetadataType; 1401 /** 1402 * The client ID. 1403 */ 1404 ClientId: ClientIdType; 1405 } 1406 export interface InitiateAuthResponse { 1407 /** 1408 * The name of the challenge. 1409 */ 1410 ChallengeName?: ChallengeNameType; 1411 /** 1412 * The session. 1413 */ 1414 Session?: SessionType; 1415 /** 1416 * The challenge parameters. 1417 */ 1418 ChallengeParameters?: ChallengeParametersType; 1419 /** 1420 * The result returned by the server in response to the request to initiate authentication. 1421 */ 1422 AuthenticationResult?: AuthenticationResultType; 1423 } 1424 export type IntegerType = number; 1425 export interface LambdaConfigType { 1426 /** 1427 * A pre-registration AWS Lambda trigger. 1428 */ 1429 PreSignUp?: ArnType; 1430 /** 1431 * A custom Message AWS Lambda trigger. 1432 */ 1433 CustomMessage?: ArnType; 1434 /** 1435 * A post-confirmation AWS Lambda trigger. 1436 */ 1437 PostConfirmation?: ArnType; 1438 /** 1439 * A pre-authentication AWS Lambda trigger. 1440 */ 1441 PreAuthentication?: ArnType; 1442 /** 1443 * A post-authentication AWS Lambda trigger. 1444 */ 1445 PostAuthentication?: ArnType; 1446 /** 1447 * Defines the authentication challenge. 1448 */ 1449 DefineAuthChallenge?: ArnType; 1450 /** 1451 * Creates an authentication challenge. 1452 */ 1453 CreateAuthChallenge?: ArnType; 1454 /** 1455 * Verifies the authentication challenge response. 1456 */ 1457 VerifyAuthChallengeResponse?: ArnType; 1458 } 1459 export interface ListDevicesRequest { 1460 /** 1461 * The access tokens for the request to list devices. 1462 */ 1463 AccessToken: TokenModelType; 1464 /** 1465 * The limit of the device request. 1466 */ 1467 Limit?: QueryLimitType; 1468 /** 1469 * The pagination token for the list request. 1470 */ 1471 PaginationToken?: SearchPaginationTokenType; 1472 } 1473 export interface ListDevicesResponse { 1474 /** 1475 * The devices returned in the list devices response. 1476 */ 1477 Devices?: DeviceListType; 1478 /** 1479 * The pagination token for the list device response. 1480 */ 1481 PaginationToken?: SearchPaginationTokenType; 1482 } 1483 export type ListOfStringTypes = StringType[]; 1484 export interface ListUserImportJobsRequest { 1485 /** 1486 * The user pool ID for the user pool that the users are being imported into. 1487 */ 1488 UserPoolId: UserPoolIdType; 1489 /** 1490 * The maximum number of import jobs you want the request to return. 1491 */ 1492 MaxResults: PoolQueryLimitType; 1493 /** 1494 * An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list. 1495 */ 1496 PaginationToken?: PaginationKeyType; 1497 } 1498 export interface ListUserImportJobsResponse { 1499 /** 1500 * The user import jobs. 1501 */ 1502 UserImportJobs?: UserImportJobsListType; 1503 /** 1504 * An identifier that can be used to return the next set of user import jobs in the list. 1505 */ 1506 PaginationToken?: PaginationKeyType; 1507 } 1508 export interface ListUserPoolClientsRequest { 1509 /** 1510 * The user pool ID for the user pool where you want to list user pool clients. 1511 */ 1512 UserPoolId: UserPoolIdType; 1513 /** 1514 * The maximum number of results you want the request to return when listing the user pool clients. 1515 */ 1516 MaxResults?: QueryLimit; 1517 /** 1518 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. 1519 */ 1520 NextToken?: PaginationKey; 1521 } 1522 export interface ListUserPoolClientsResponse { 1523 /** 1524 * The user pool clients in the response that lists user pool clients. 1525 */ 1526 UserPoolClients?: UserPoolClientListType; 1527 /** 1528 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. 1529 */ 1530 NextToken?: PaginationKey; 1531 } 1532 export interface ListUserPoolsRequest { 1533 /** 1534 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. 1535 */ 1536 NextToken?: PaginationKeyType; 1537 /** 1538 * The maximum number of results you want the request to return when listing the user pools. 1539 */ 1540 MaxResults: PoolQueryLimitType; 1541 } 1542 export interface ListUserPoolsResponse { 1543 /** 1544 * The user pools from the response to list users. 1545 */ 1546 UserPools?: UserPoolListType; 1547 /** 1548 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. 1549 */ 1550 NextToken?: PaginationKeyType; 1551 } 1552 export interface ListUsersRequest { 1553 /** 1554 * The user pool ID for which you want to list users. 1555 */ 1556 UserPoolId: UserPoolIdType; 1557 /** 1558 * The attributes to get from the request to list users. 1559 */ 1560 AttributesToGet?: SearchedAttributeNamesListType; 1561 /** 1562 * The limit of the request to list users. 1563 */ 1564 Limit?: QueryLimitType; 1565 /** 1566 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. 1567 */ 1568 PaginationToken?: SearchPaginationTokenType; 1569 /** 1570 * The filter for the list users request. 1571 */ 1572 Filter?: UserFilterType; 1573 } 1574 export interface ListUsersResponse { 1575 /** 1576 * The users returned in the request to list users. 1577 */ 1578 Users?: UsersListType; 1579 /** 1580 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. 1581 */ 1582 PaginationToken?: SearchPaginationTokenType; 1583 } 1584 export type LongType = number; 1585 export type MFAOptionListType = MFAOptionType[]; 1586 export interface MFAOptionType { 1587 /** 1588 * The delivery medium (email message or SMS message) to send the MFA code. 1589 */ 1590 DeliveryMedium?: DeliveryMediumType; 1591 /** 1592 * The attribute name of the MFA option type. 1593 */ 1594 AttributeName?: AttributeNameType; 1595 } 1596 export type MessageActionType = "RESEND"|"SUPPRESS"|string; 1597 export interface MessageTemplateType { 1598 /** 1599 * The message template for SMS messages. 1600 */ 1601 SMSMessage?: SmsVerificationMessageType; 1602 /** 1603 * The message template for email messages. 1604 */ 1605 EmailMessage?: EmailVerificationMessageType; 1606 /** 1607 * The subject line for email messages. 1608 */ 1609 EmailSubject?: EmailVerificationSubjectType; 1610 } 1611 export type MessageType = string; 1612 export interface NewDeviceMetadataType { 1613 /** 1614 * The device key. 1615 */ 1616 DeviceKey?: DeviceKeyType; 1617 /** 1618 * The device group key. 1619 */ 1620 DeviceGroupKey?: StringType; 1621 } 1622 export interface NumberAttributeConstraintsType { 1623 /** 1624 * The minimum value of an attribute that is of the number data type. 1625 */ 1626 MinValue?: StringType; 1627 /** 1628 * The maximum value of an attribute that is of the number data type. 1629 */ 1630 MaxValue?: StringType; 1631 } 1632 export type PaginationKey = string; 1633 export type PaginationKeyType = string; 1634 export type PasswordPolicyMinLengthType = number; 1635 export interface PasswordPolicyType { 1636 /** 1637 * The minimum length of the password policy that you have set. Cannot be less than 6. 1638 */ 1639 MinimumLength?: PasswordPolicyMinLengthType; 1640 /** 1641 * In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password. 1642 */ 1643 RequireUppercase?: BooleanType; 1644 /** 1645 * In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password. 1646 */ 1647 RequireLowercase?: BooleanType; 1648 /** 1649 * In the password policy that you have set, refers to whether you have required users to use at least one number in their password. 1650 */ 1651 RequireNumbers?: BooleanType; 1652 /** 1653 * In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password. 1654 */ 1655 RequireSymbols?: BooleanType; 1656 } 1657 export type PasswordType = string; 1658 export type PoolQueryLimitType = number; 1659 export type PreSignedUrlType = string; 1660 export type QueryLimit = number; 1661 export type QueryLimitType = number; 1662 export type RefreshTokenValidityType = number; 1663 export interface ResendConfirmationCodeRequest { 1664 /** 1665 * The ID of the client associated with the user pool. 1666 */ 1667 ClientId: ClientIdType; 1668 /** 1669 * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. 1670 */ 1671 SecretHash?: SecretHashType; 1672 /** 1673 * The user name of the user to whom you wish to resend a confirmation code. 1674 */ 1675 Username: UsernameType; 1676 } 1677 export interface ResendConfirmationCodeResponse { 1678 /** 1679 * The code delivery details returned by the server in response to the request to resend the confirmation code. 1680 */ 1681 CodeDeliveryDetails?: CodeDeliveryDetailsType; 1682 } 1683 export interface RespondToAuthChallengeRequest { 1684 /** 1685 * The client ID. 1686 */ 1687 ClientId: ClientIdType; 1688 /** 1689 * The name of the challenge. 1690 */ 1691 ChallengeName: ChallengeNameType; 1692 /** 1693 * The session. 1694 */ 1695 Session?: SessionType; 1696 /** 1697 * The responses to the authentication challenge. 1698 */ 1699 ChallengeResponses?: ChallengeResponsesType; 1700 } 1701 export interface RespondToAuthChallengeResponse { 1702 /** 1703 * The challenge name. 1704 */ 1705 ChallengeName?: ChallengeNameType; 1706 /** 1707 * The session. 1708 */ 1709 Session?: SessionType; 1710 /** 1711 * The challenge parameters. 1712 */ 1713 ChallengeParameters?: ChallengeParametersType; 1714 /** 1715 * The result returned by the server in response to the request to respond to the authentication challenge. 1716 */ 1717 AuthenticationResult?: AuthenticationResultType; 1718 } 1719 export interface SchemaAttributeType { 1720 /** 1721 * A schema attribute of the name type. 1722 */ 1723 Name?: CustomAttributeNameType; 1724 /** 1725 * The attribute data type. 1726 */ 1727 AttributeDataType?: AttributeDataType; 1728 /** 1729 * Specifies whether the attribute type is developer only. 1730 */ 1731 DeveloperOnlyAttribute?: BooleanType; 1732 /** 1733 * Specifies whether the attribute can be changed once it has been created. 1734 */ 1735 Mutable?: BooleanType; 1736 /** 1737 * Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail. 1738 */ 1739 Required?: BooleanType; 1740 /** 1741 * Specifies the constraints for an attribute of the number type. 1742 */ 1743 NumberAttributeConstraints?: NumberAttributeConstraintsType; 1744 /** 1745 * Specifies the constraints for an attribute of the string type. 1746 */ 1747 StringAttributeConstraints?: StringAttributeConstraintsType; 1748 } 1749 export type SchemaAttributesListType = SchemaAttributeType[]; 1750 export type SearchPaginationTokenType = string; 1751 export type SearchedAttributeNamesListType = AttributeNameType[]; 1752 export type SecretHashType = string; 1753 export type SessionType = string; 1754 export interface SetUserSettingsRequest { 1755 /** 1756 * The access token for the set user settings request. 1757 */ 1758 AccessToken: TokenModelType; 1759 /** 1760 * Specifies the options for MFA (e.g., email or phone number). 1761 */ 1762 MFAOptions: MFAOptionListType; 1763 } 1764 export interface SetUserSettingsResponse { 1765 } 1766 export interface SignUpRequest { 1767 /** 1768 * The ID of the client associated with the user pool. 1769 */ 1770 ClientId: ClientIdType; 1771 /** 1772 * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. 1773 */ 1774 SecretHash?: SecretHashType; 1775 /** 1776 * The user name of the user you wish to register. 1777 */ 1778 Username: UsernameType; 1779 /** 1780 * The password of the user you wish to register. 1781 */ 1782 Password: PasswordType; 1783 /** 1784 * An array of name-value pairs representing user attributes. 1785 */ 1786 UserAttributes?: AttributeListType; 1787 /** 1788 * The validation data in the request to register a user. 1789 */ 1790 ValidationData?: AttributeListType; 1791 } 1792 export interface SignUpResponse { 1793 /** 1794 * A response from the server indicating that a user registration has been confirmed. 1795 */ 1796 UserConfirmed?: BooleanType; 1797 /** 1798 * The code delivery details returned by the server response to the user registration request. 1799 */ 1800 CodeDeliveryDetails?: CodeDeliveryDetailsType; 1801 } 1802 export interface SmsConfigurationType { 1803 /** 1804 * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. 1805 */ 1806 SnsCallerArn: ArnType; 1807 /** 1808 * The external ID. 1809 */ 1810 ExternalId?: StringType; 1811 } 1812 export type SmsVerificationMessageType = string; 1813 export interface StartUserImportJobRequest { 1814 /** 1815 * The user pool ID for the user pool that the users are being imported into. 1816 */ 1817 UserPoolId: UserPoolIdType; 1818 /** 1819 * The job ID for the user import job. 1820 */ 1821 JobId: UserImportJobIdType; 1822 } 1823 export interface StartUserImportJobResponse { 1824 /** 1825 * The job object that represents the user import job. 1826 */ 1827 UserImportJob?: UserImportJobType; 1828 } 1829 export type StatusType = "Enabled"|"Disabled"|string; 1830 export interface StopUserImportJobRequest { 1831 /** 1832 * The user pool ID for the user pool that the users are being imported into. 1833 */ 1834 UserPoolId: UserPoolIdType; 1835 /** 1836 * The job ID for the user import job. 1837 */ 1838 JobId: UserImportJobIdType; 1839 } 1840 export interface StopUserImportJobResponse { 1841 /** 1842 * The job object that represents the user import job. 1843 */ 1844 UserImportJob?: UserImportJobType; 1845 } 1846 export interface StringAttributeConstraintsType { 1847 /** 1848 * The minimum length of an attribute value of the string type. 1849 */ 1850 MinLength?: StringType; 1851 /** 1852 * The maximum length of an attribute value of the string type. 1853 */ 1854 MaxLength?: StringType; 1855 } 1856 export type StringType = string; 1857 export type TokenModelType = string; 1858 export interface UpdateDeviceStatusRequest { 1859 /** 1860 * The access token. 1861 */ 1862 AccessToken: TokenModelType; 1863 /** 1864 * The device key. 1865 */ 1866 DeviceKey: DeviceKeyType; 1867 /** 1868 * The status of whether a device is remembered. 1869 */ 1870 DeviceRememberedStatus?: DeviceRememberedStatusType; 1871 } 1872 export interface UpdateDeviceStatusResponse { 1873 } 1874 export interface UpdateUserAttributesRequest { 1875 /** 1876 * An array of name-value pairs representing user attributes. 1877 */ 1878 UserAttributes: AttributeListType; 1879 /** 1880 * The access token for the request to update user attributes. 1881 */ 1882 AccessToken?: TokenModelType; 1883 } 1884 export interface UpdateUserAttributesResponse { 1885 /** 1886 * The code delivery details list from the server for the request to update user attributes. 1887 */ 1888 CodeDeliveryDetailsList?: CodeDeliveryDetailsListType; 1889 } 1890 export interface UpdateUserPoolClientRequest { 1891 /** 1892 * The user pool ID for the user pool where you want to update the user pool client. 1893 */ 1894 UserPoolId: UserPoolIdType; 1895 /** 1896 * The ID of the client associated with the user pool. 1897 */ 1898 ClientId: ClientIdType; 1899 /** 1900 * The client name from the update user pool client request. 1901 */ 1902 ClientName?: ClientNameType; 1903 /** 1904 * The validity of the refresh token. 1905 */ 1906 RefreshTokenValidity?: RefreshTokenValidityType; 1907 /** 1908 * The read-only attributes of the user pool. 1909 */ 1910 ReadAttributes?: ClientPermissionListType; 1911 /** 1912 * The writeable attributes of the user pool. 1913 */ 1914 WriteAttributes?: ClientPermissionListType; 1915 /** 1916 * Explicit authentication flows. 1917 */ 1918 ExplicitAuthFlows?: ExplicitAuthFlowsListType; 1919 } 1920 export interface UpdateUserPoolClientResponse { 1921 /** 1922 * The user pool client value from the response from the server when an update user pool client request is made. 1923 */ 1924 UserPoolClient?: UserPoolClientType; 1925 } 1926 export interface UpdateUserPoolRequest { 1927 /** 1928 * The user pool ID for the user pool you want to update. 1929 */ 1930 UserPoolId: UserPoolIdType; 1931 /** 1932 * A container with the policies you wish to update in a user pool. 1933 */ 1934 Policies?: UserPoolPolicyType; 1935 /** 1936 * The AWS Lambda configuration information from the request to update the user pool. 1937 */ 1938 LambdaConfig?: LambdaConfigType; 1939 /** 1940 * The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools. 1941 */ 1942 AutoVerifiedAttributes?: VerifiedAttributesListType; 1943 /** 1944 * A container with information about the SMS verification message. 1945 */ 1946 SmsVerificationMessage?: SmsVerificationMessageType; 1947 /** 1948 * The contents of the email verification message. 1949 */ 1950 EmailVerificationMessage?: EmailVerificationMessageType; 1951 /** 1952 * The subject of the email verfication message. 1953 */ 1954 EmailVerificationSubject?: EmailVerificationSubjectType; 1955 /** 1956 * The contents of the SMS authentication message. 1957 */ 1958 SmsAuthenticationMessage?: SmsVerificationMessageType; 1959 /** 1960 * Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token. 1961 */ 1962 MfaConfiguration?: UserPoolMfaType; 1963 /** 1964 * Device configuration. 1965 */ 1966 DeviceConfiguration?: DeviceConfigurationType; 1967 /** 1968 * Email configuration. 1969 */ 1970 EmailConfiguration?: EmailConfigurationType; 1971 /** 1972 * SMS configuration. 1973 */ 1974 SmsConfiguration?: SmsConfigurationType; 1975 /** 1976 * The configuration for AdminCreateUser requests. 1977 */ 1978 AdminCreateUserConfig?: AdminCreateUserConfigType; 1979 } 1980 export interface UpdateUserPoolResponse { 1981 } 1982 export type UserFilterType = string; 1983 export type UserImportJobIdType = string; 1984 export type UserImportJobNameType = string; 1985 export type UserImportJobStatusType = "Created"|"Pending"|"InProgress"|"Stopping"|"Expired"|"Stopped"|"Failed"|"Succeeded"|string; 1986 export interface UserImportJobType { 1987 /** 1988 * The job name for the user import job. 1989 */ 1990 JobName?: UserImportJobNameType; 1991 /** 1992 * The job ID for the user import job. 1993 */ 1994 JobId?: UserImportJobIdType; 1995 /** 1996 * The user pool ID for the user pool that the users are being imported into. 1997 */ 1998 UserPoolId?: UserPoolIdType; 1999 /** 2000 * The pre-signed URL to be used to upload the .csv file. 2001 */ 2002 PreSignedUrl?: PreSignedUrlType; 2003 /** 2004 * The date when the user import job was created. 2005 */ 2006 CreationDate?: DateType; 2007 /** 2008 * The date when the user import job was started. 2009 */ 2010 StartDate?: DateType; 2011 /** 2012 * The date when the user imoprt job was completed. 2013 */ 2014 CompletionDate?: DateType; 2015 /** 2016 * The status of the user import job. One of the following: Created - The job was created but not started. Pending - A transition state. You have started the job, but it has not begun importing users yet. InProgress - The job has started, and users are being imported. Stopping - You have stopped the job, but the job has not stopped importing users yet. Stopped - You have stopped the job, and the job has stopped importing users. Succeeded - The job has completed successfully. Failed - The job has stopped due to an error. Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started. 2017 */ 2018 Status?: UserImportJobStatusType; 2019 /** 2020 * The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide. 2021 */ 2022 CloudWatchLogsRoleArn?: ArnType; 2023 /** 2024 * The number of users that were successfully imported. 2025 */ 2026 ImportedUsers?: LongType; 2027 /** 2028 * The number of users that were skipped. 2029 */ 2030 SkippedUsers?: LongType; 2031 /** 2032 * The number of users that could not be imported. 2033 */ 2034 FailedUsers?: LongType; 2035 /** 2036 * The message returned when the user import job is completed. 2037 */ 2038 CompletionMessage?: CompletionMessageType; 2039 } 2040 export type UserImportJobsListType = UserImportJobType[]; 2041 export interface UserPoolClientDescription { 2042 /** 2043 * The ID of the client associated with the user pool. 2044 */ 2045 ClientId?: ClientIdType; 2046 /** 2047 * The user pool ID for the user pool where you want to describe the user pool client. 2048 */ 2049 UserPoolId?: UserPoolIdType; 2050 /** 2051 * The client name from the user pool client description. 2052 */ 2053 ClientName?: ClientNameType; 2054 } 2055 export type UserPoolClientListType = UserPoolClientDescription[]; 2056 export interface UserPoolClientType { 2057 /** 2058 * The user pool ID for the user pool client. 2059 */ 2060 UserPoolId?: UserPoolIdType; 2061 /** 2062 * The client name from the user pool request of the client type. 2063 */ 2064 ClientName?: ClientNameType; 2065 /** 2066 * The ID of the client associated with the user pool. 2067 */ 2068 ClientId?: ClientIdType; 2069 /** 2070 * The client secret from the user pool request of the client type. 2071 */ 2072 ClientSecret?: ClientSecretType; 2073 /** 2074 * The last modified date from the user pool request of the client type. 2075 */ 2076 LastModifiedDate?: DateType; 2077 /** 2078 * The creation date from the user pool request of the client type. 2079 */ 2080 CreationDate?: DateType; 2081 /** 2082 * The validity of the refresh token. 2083 */ 2084 RefreshTokenValidity?: RefreshTokenValidityType; 2085 /** 2086 * The Read-only attributes. 2087 */ 2088 ReadAttributes?: ClientPermissionListType; 2089 /** 2090 * The writeable attributes. 2091 */ 2092 WriteAttributes?: ClientPermissionListType; 2093 /** 2094 * The explicit authentication flows. 2095 */ 2096 ExplicitAuthFlows?: ExplicitAuthFlowsListType; 2097 } 2098 export interface UserPoolDescriptionType { 2099 /** 2100 * The ID in a user pool description. 2101 */ 2102 Id?: UserPoolIdType; 2103 /** 2104 * The name in a user pool description. 2105 */ 2106 Name?: UserPoolNameType; 2107 /** 2108 * The AWS Lambda configuration information in a user pool description. 2109 */ 2110 LambdaConfig?: LambdaConfigType; 2111 /** 2112 * The user pool status in a user pool description. 2113 */ 2114 Status?: StatusType; 2115 /** 2116 * The last modified date in a user pool description. 2117 */ 2118 LastModifiedDate?: DateType; 2119 /** 2120 * The creation date in a user pool description. 2121 */ 2122 CreationDate?: DateType; 2123 } 2124 export type UserPoolIdType = string; 2125 export type UserPoolListType = UserPoolDescriptionType[]; 2126 export type UserPoolMfaType = "OFF"|"ON"|"OPTIONAL"|string; 2127 export type UserPoolNameType = string; 2128 export interface UserPoolPolicyType { 2129 /** 2130 * A container with information about the user pool password policy. 2131 */ 2132 PasswordPolicy?: PasswordPolicyType; 2133 } 2134 export interface UserPoolType { 2135 /** 2136 * The ID of the user pool. 2137 */ 2138 Id?: UserPoolIdType; 2139 /** 2140 * The name of the user pool. 2141 */ 2142 Name?: UserPoolNameType; 2143 /** 2144 * A container describing the policies associated with a user pool. 2145 */ 2146 Policies?: UserPoolPolicyType; 2147 /** 2148 * A container describing the AWS Lambda triggers associated with a user pool. 2149 */ 2150 LambdaConfig?: LambdaConfigType; 2151 /** 2152 * The status of a user pool. 2153 */ 2154 Status?: StatusType; 2155 /** 2156 * The last modified date of a user pool. 2157 */ 2158 LastModifiedDate?: DateType; 2159 /** 2160 * The creation date of a user pool. 2161 */ 2162 CreationDate?: DateType; 2163 /** 2164 * A container with the schema attributes of a user pool. 2165 */ 2166 SchemaAttributes?: SchemaAttributesListType; 2167 /** 2168 * Specifies the attributes that are auto-verified in a user pool. 2169 */ 2170 AutoVerifiedAttributes?: VerifiedAttributesListType; 2171 /** 2172 * Specifies the attributes that are aliased in a user pool. 2173 */ 2174 AliasAttributes?: AliasAttributesListType; 2175 /** 2176 * The contents of the SMS verification message. 2177 */ 2178 SmsVerificationMessage?: SmsVerificationMessageType; 2179 /** 2180 * The contents of the email verification message. 2181 */ 2182 EmailVerificationMessage?: EmailVerificationMessageType; 2183 /** 2184 * The subject of the email verification message. 2185 */ 2186 EmailVerificationSubject?: EmailVerificationSubjectType; 2187 /** 2188 * The contents of the SMS authentication message. 2189 */ 2190 SmsAuthenticationMessage?: SmsVerificationMessageType; 2191 /** 2192 * Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token. 2193 */ 2194 MfaConfiguration?: UserPoolMfaType; 2195 /** 2196 * The device configuration. 2197 */ 2198 DeviceConfiguration?: DeviceConfigurationType; 2199 /** 2200 * A number estimating the size of the user pool. 2201 */ 2202 EstimatedNumberOfUsers?: IntegerType; 2203 /** 2204 * The email configuration. 2205 */ 2206 EmailConfiguration?: EmailConfigurationType; 2207 /** 2208 * The SMS configuration. 2209 */ 2210 SmsConfiguration?: SmsConfigurationType; 2211 /** 2212 * The reason why the SMS configuration cannot send the message(s) to your users. 2213 */ 2214 SmsConfigurationFailure?: StringType; 2215 /** 2216 * The reason why the email configuration cannot send the messages to your users. 2217 */ 2218 EmailConfigurationFailure?: StringType; 2219 /** 2220 * The configuration for AdminCreateUser requests. 2221 */ 2222 AdminCreateUserConfig?: AdminCreateUserConfigType; 2223 } 2224 export type UserStatusType = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|string; 2225 export interface UserType { 2226 /** 2227 * The user name of the user you wish to describe. 2228 */ 2229 Username?: UsernameType; 2230 /** 2231 * A container with information about the user type attributes. 2232 */ 2233 Attributes?: AttributeListType; 2234 /** 2235 * The creation date of the user. 2236 */ 2237 UserCreateDate?: DateType; 2238 /** 2239 * The last modified date of the user. 2240 */ 2241 UserLastModifiedDate?: DateType; 2242 /** 2243 * Specifies whether the user is enabled. 2244 */ 2245 Enabled?: BooleanType; 2246 /** 2247 * The user status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. COMPROMISED - User is disabled due to a potential security threat. UNKNOWN - User status is not known. 2248 */ 2249 UserStatus?: UserStatusType; 2250 /** 2251 * The MFA options for the user. 2252 */ 2253 MFAOptions?: MFAOptionListType; 2254 } 2255 export type UsernameType = string; 2256 export type UsersListType = UserType[]; 2257 export type VerifiedAttributeType = "phone_number"|"email"|string; 2258 export type VerifiedAttributesListType = VerifiedAttributeType[]; 2259 export interface VerifyUserAttributeRequest { 2260 /** 2261 * Represents the access token of the request to verify user attributes. 2262 */ 2263 AccessToken?: TokenModelType; 2264 /** 2265 * The attribute name in the request to verify user attributes. 2266 */ 2267 AttributeName: AttributeNameType; 2268 /** 2269 * The verification code in the request to verify user attributes. 2270 */ 2271 Code: ConfirmationCodeType; 2272 } 2273 export interface VerifyUserAttributeResponse { 2274 } 2275 /** 2276 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2277 */ 2278 export type apiVersion = "2016-04-18"|"latest"|string; 2279 export interface ClientApiVersions { 2280 /** 2281 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2282 */ 2283 apiVersion?: apiVersion; 2284 } 2285 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 2286 } 2287 export = CognitoIdentityServiceProvider;