/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / amplifybackend.d.ts
amplifybackend.d.ts
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-base'; 7 interface Blob {} 8 declare class AmplifyBackend extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: AmplifyBackend.Types.ClientConfiguration) 13 config: Config & AmplifyBackend.Types.ClientConfiguration; 14 /** 15 * This operation clones an existing backend. 16 */ 17 cloneBackend(params: AmplifyBackend.Types.CloneBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request<AmplifyBackend.Types.CloneBackendResponse, AWSError>; 18 /** 19 * This operation clones an existing backend. 20 */ 21 cloneBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request<AmplifyBackend.Types.CloneBackendResponse, AWSError>; 22 /** 23 * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. 24 */ 25 createBackend(params: AmplifyBackend.Types.CreateBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendResponse) => void): Request<AmplifyBackend.Types.CreateBackendResponse, AWSError>; 26 /** 27 * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. 28 */ 29 createBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendResponse) => void): Request<AmplifyBackend.Types.CreateBackendResponse, AWSError>; 30 /** 31 * Creates a new backend API resource. 32 */ 33 createBackendAPI(params: AmplifyBackend.Types.CreateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request<AmplifyBackend.Types.CreateBackendAPIResponse, AWSError>; 34 /** 35 * Creates a new backend API resource. 36 */ 37 createBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request<AmplifyBackend.Types.CreateBackendAPIResponse, AWSError>; 38 /** 39 * Creates a new backend authentication resource. 40 */ 41 createBackendAuth(params: AmplifyBackend.Types.CreateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request<AmplifyBackend.Types.CreateBackendAuthResponse, AWSError>; 42 /** 43 * Creates a new backend authentication resource. 44 */ 45 createBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request<AmplifyBackend.Types.CreateBackendAuthResponse, AWSError>; 46 /** 47 * Creates a config object for a backend. 48 */ 49 createBackendConfig(params: AmplifyBackend.Types.CreateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request<AmplifyBackend.Types.CreateBackendConfigResponse, AWSError>; 50 /** 51 * Creates a config object for a backend. 52 */ 53 createBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request<AmplifyBackend.Types.CreateBackendConfigResponse, AWSError>; 54 /** 55 * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. 56 */ 57 createToken(params: AmplifyBackend.Types.CreateTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateTokenResponse) => void): Request<AmplifyBackend.Types.CreateTokenResponse, AWSError>; 58 /** 59 * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. 60 */ 61 createToken(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateTokenResponse) => void): Request<AmplifyBackend.Types.CreateTokenResponse, AWSError>; 62 /** 63 * Removes an existing environment from your Amplify project. 64 */ 65 deleteBackend(params: AmplifyBackend.Types.DeleteBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request<AmplifyBackend.Types.DeleteBackendResponse, AWSError>; 66 /** 67 * Removes an existing environment from your Amplify project. 68 */ 69 deleteBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request<AmplifyBackend.Types.DeleteBackendResponse, AWSError>; 70 /** 71 * Deletes an existing backend API resource. 72 */ 73 deleteBackendAPI(params: AmplifyBackend.Types.DeleteBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAPIResponse, AWSError>; 74 /** 75 * Deletes an existing backend API resource. 76 */ 77 deleteBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAPIResponse, AWSError>; 78 /** 79 * Deletes an existing backend authentication resource. 80 */ 81 deleteBackendAuth(params: AmplifyBackend.Types.DeleteBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAuthResponse, AWSError>; 82 /** 83 * Deletes an existing backend authentication resource. 84 */ 85 deleteBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAuthResponse, AWSError>; 86 /** 87 * Deletes the challenge token based on the given appId and sessionId. 88 */ 89 deleteToken(params: AmplifyBackend.Types.DeleteTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request<AmplifyBackend.Types.DeleteTokenResponse, AWSError>; 90 /** 91 * Deletes the challenge token based on the given appId and sessionId. 92 */ 93 deleteToken(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request<AmplifyBackend.Types.DeleteTokenResponse, AWSError>; 94 /** 95 * Generates a model schema for an existing backend API resource. 96 */ 97 generateBackendAPIModels(params: AmplifyBackend.Types.GenerateBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GenerateBackendAPIModelsResponse, AWSError>; 98 /** 99 * Generates a model schema for an existing backend API resource. 100 */ 101 generateBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GenerateBackendAPIModelsResponse, AWSError>; 102 /** 103 * Provides project-level details for your Amplify UI project. 104 */ 105 getBackend(params: AmplifyBackend.Types.GetBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request<AmplifyBackend.Types.GetBackendResponse, AWSError>; 106 /** 107 * Provides project-level details for your Amplify UI project. 108 */ 109 getBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request<AmplifyBackend.Types.GetBackendResponse, AWSError>; 110 /** 111 * Gets the details for a backend API. 112 */ 113 getBackendAPI(params: AmplifyBackend.Types.GetBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIResponse, AWSError>; 114 /** 115 * Gets the details for a backend API. 116 */ 117 getBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIResponse, AWSError>; 118 /** 119 * Generates a model schema for existing backend API resource. 120 */ 121 getBackendAPIModels(params: AmplifyBackend.Types.GetBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIModelsResponse, AWSError>; 122 /** 123 * Generates a model schema for existing backend API resource. 124 */ 125 getBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIModelsResponse, AWSError>; 126 /** 127 * Gets a backend auth details. 128 */ 129 getBackendAuth(params: AmplifyBackend.Types.GetBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request<AmplifyBackend.Types.GetBackendAuthResponse, AWSError>; 130 /** 131 * Gets a backend auth details. 132 */ 133 getBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request<AmplifyBackend.Types.GetBackendAuthResponse, AWSError>; 134 /** 135 * Returns information about a specific job. 136 */ 137 getBackendJob(params: AmplifyBackend.Types.GetBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request<AmplifyBackend.Types.GetBackendJobResponse, AWSError>; 138 /** 139 * Returns information about a specific job. 140 */ 141 getBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request<AmplifyBackend.Types.GetBackendJobResponse, AWSError>; 142 /** 143 * Gets the challenge token based on the given appId and sessionId. 144 */ 145 getToken(params: AmplifyBackend.Types.GetTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request<AmplifyBackend.Types.GetTokenResponse, AWSError>; 146 /** 147 * Gets the challenge token based on the given appId and sessionId. 148 */ 149 getToken(callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request<AmplifyBackend.Types.GetTokenResponse, AWSError>; 150 /** 151 * Imports an existing backend authentication resource. 152 */ 153 importBackendAuth(params: AmplifyBackend.Types.ImportBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request<AmplifyBackend.Types.ImportBackendAuthResponse, AWSError>; 154 /** 155 * Imports an existing backend authentication resource. 156 */ 157 importBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request<AmplifyBackend.Types.ImportBackendAuthResponse, AWSError>; 158 /** 159 * Lists the jobs for the backend of an Amplify app. 160 */ 161 listBackendJobs(params: AmplifyBackend.Types.ListBackendJobsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request<AmplifyBackend.Types.ListBackendJobsResponse, AWSError>; 162 /** 163 * Lists the jobs for the backend of an Amplify app. 164 */ 165 listBackendJobs(callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request<AmplifyBackend.Types.ListBackendJobsResponse, AWSError>; 166 /** 167 * Removes all backend environments from your Amplify project. 168 */ 169 removeAllBackends(params: AmplifyBackend.Types.RemoveAllBackendsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request<AmplifyBackend.Types.RemoveAllBackendsResponse, AWSError>; 170 /** 171 * Removes all backend environments from your Amplify project. 172 */ 173 removeAllBackends(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request<AmplifyBackend.Types.RemoveAllBackendsResponse, AWSError>; 174 /** 175 * Removes the AWS resources required to access the Amplify Admin UI. 176 */ 177 removeBackendConfig(params: AmplifyBackend.Types.RemoveBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request<AmplifyBackend.Types.RemoveBackendConfigResponse, AWSError>; 178 /** 179 * Removes the AWS resources required to access the Amplify Admin UI. 180 */ 181 removeBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request<AmplifyBackend.Types.RemoveBackendConfigResponse, AWSError>; 182 /** 183 * Updates an existing backend API resource. 184 */ 185 updateBackendAPI(params: AmplifyBackend.Types.UpdateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAPIResponse, AWSError>; 186 /** 187 * Updates an existing backend API resource. 188 */ 189 updateBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAPIResponse, AWSError>; 190 /** 191 * Updates an existing backend authentication resource. 192 */ 193 updateBackendAuth(params: AmplifyBackend.Types.UpdateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAuthResponse, AWSError>; 194 /** 195 * Updates an existing backend authentication resource. 196 */ 197 updateBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAuthResponse, AWSError>; 198 /** 199 * Updates the AWS resources required to access the Amplify Admin UI. 200 */ 201 updateBackendConfig(params: AmplifyBackend.Types.UpdateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request<AmplifyBackend.Types.UpdateBackendConfigResponse, AWSError>; 202 /** 203 * Updates the AWS resources required to access the Amplify Admin UI. 204 */ 205 updateBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request<AmplifyBackend.Types.UpdateBackendConfigResponse, AWSError>; 206 /** 207 * Updates a specific job. 208 */ 209 updateBackendJob(params: AmplifyBackend.Types.UpdateBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request<AmplifyBackend.Types.UpdateBackendJobResponse, AWSError>; 210 /** 211 * Updates a specific job. 212 */ 213 updateBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request<AmplifyBackend.Types.UpdateBackendJobResponse, AWSError>; 214 } 215 declare namespace AmplifyBackend { 216 export type AuthResources = "USER_POOL_ONLY"|"IDENTITY_POOL_AND_USER_POOL"|string; 217 export interface BackendAPIAppSyncAuthSettings { 218 /** 219 * The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. 220 */ 221 CognitoUserPoolId?: __string; 222 /** 223 * The API key description for API_KEY, if it was used as an authentication mechanism to access your data models. 224 */ 225 Description?: __string; 226 /** 227 * The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. 228 */ 229 ExpirationTime?: __double; 230 /** 231 * The expiry time for the OpenID authentication mechanism. 232 */ 233 OpenIDAuthTTL?: __string; 234 /** 235 * The clientID for openID, if openID was used as an authentication setting to access your data models. 236 */ 237 OpenIDClientId?: __string; 238 /** 239 * The expiry time for the OpenID authentication mechanism. 240 */ 241 OpenIDIatTTL?: __string; 242 /** 243 * The openID issuer URL, if openID was used as an authentication setting to access your data models. 244 */ 245 OpenIDIssueURL?: __string; 246 /** 247 * The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. 248 */ 249 OpenIDProviderName?: __string; 250 } 251 export interface BackendAPIAuthType { 252 /** 253 * Describes the authentication mode. 254 */ 255 Mode?: Mode; 256 /** 257 * Describes settings for the authentication mode. 258 */ 259 Settings?: BackendAPIAppSyncAuthSettings; 260 } 261 export interface BackendAPIConflictResolution { 262 /** 263 * The strategy for conflict resolution. 264 */ 265 ResolutionStrategy?: ResolutionStrategy; 266 } 267 export interface BackendAPIResourceConfig { 268 /** 269 * Additional authentication methods used to interact with your data models. 270 */ 271 AdditionalAuthTypes?: ListOfBackendAPIAuthType; 272 /** 273 * The API name used to interact with the data model, configured as a part of your Amplify project. 274 */ 275 ApiName?: __string; 276 /** 277 * The conflict resolution strategy for your data stored in the data models. 278 */ 279 ConflictResolution?: BackendAPIConflictResolution; 280 /** 281 * The default authentication type for interacting with the configured data models in your Amplify project. 282 */ 283 DefaultAuthType?: BackendAPIAuthType; 284 /** 285 * The service used to provision and interact with the data model. 286 */ 287 Service?: __string; 288 /** 289 * The definition of the data model in the annotated transform of the GraphQL schema. 290 */ 291 TransformSchema?: __string; 292 } 293 export interface BackendAuthAppleProviderConfig { 294 /** 295 * Describes the client_id (also called Services ID) that comes from Apple. 296 */ 297 ClientId?: __string; 298 /** 299 * Describes the key_id that comes from Apple. 300 */ 301 KeyId?: __string; 302 /** 303 * Describes the private_key that comes from Apple. 304 */ 305 PrivateKey?: __string; 306 /** 307 * Describes the team_id that comes from Apple. 308 */ 309 TeamId?: __string; 310 } 311 export interface BackendAuthSocialProviderConfig { 312 /** 313 * Describes the client_id, which can be obtained from the third-party social federation provider. 314 */ 315 ClientId?: __string; 316 /** 317 * Describes the client_secret, which can be obtained from third-party social federation providers. 318 */ 319 ClientSecret?: __string; 320 } 321 export interface BackendJobRespObj { 322 /** 323 * The app ID. 324 */ 325 AppId: __string; 326 /** 327 * The name of the backend environment. 328 */ 329 BackendEnvironmentName: __string; 330 /** 331 * The time when the job was created. 332 */ 333 CreateTime?: __string; 334 /** 335 * If the request fails, this error is returned. 336 */ 337 Error?: __string; 338 /** 339 * The ID for the job. 340 */ 341 JobId?: __string; 342 /** 343 * The name of the operation. 344 */ 345 Operation?: __string; 346 /** 347 * The current status of the request. 348 */ 349 Status?: __string; 350 /** 351 * The time when the job was last updated. 352 */ 353 UpdateTime?: __string; 354 } 355 export interface CloneBackendRequest { 356 /** 357 * The app ID. 358 */ 359 AppId: __string; 360 /** 361 * The name of the backend environment. 362 */ 363 BackendEnvironmentName: __string; 364 /** 365 * The name of the destination backend environment to be created. 366 */ 367 TargetEnvironmentName: __string; 368 } 369 export interface CloneBackendResponse { 370 /** 371 * The app ID. 372 */ 373 AppId?: __string; 374 /** 375 * The name of the backend environment. 376 */ 377 BackendEnvironmentName?: __string; 378 /** 379 * If the request fails, this error is returned. 380 */ 381 Error?: __string; 382 /** 383 * The ID for the job. 384 */ 385 JobId?: __string; 386 /** 387 * The name of the operation. 388 */ 389 Operation?: __string; 390 /** 391 * The current status of the request. 392 */ 393 Status?: __string; 394 } 395 export interface CreateBackendAPIRequest { 396 /** 397 * The app ID. 398 */ 399 AppId: __string; 400 /** 401 * The name of the backend environment. 402 */ 403 BackendEnvironmentName: __string; 404 /** 405 * The resource configuration for this request. 406 */ 407 ResourceConfig: BackendAPIResourceConfig; 408 /** 409 * The name of this resource. 410 */ 411 ResourceName: __string; 412 } 413 export interface CreateBackendAPIResponse { 414 /** 415 * The app ID. 416 */ 417 AppId?: __string; 418 /** 419 * The name of the backend environment. 420 */ 421 BackendEnvironmentName?: __string; 422 /** 423 * If the request fails, this error is returned. 424 */ 425 Error?: __string; 426 /** 427 * The ID for the job. 428 */ 429 JobId?: __string; 430 /** 431 * The name of the operation. 432 */ 433 Operation?: __string; 434 /** 435 * The current status of the request. 436 */ 437 Status?: __string; 438 } 439 export interface CreateBackendAuthForgotPasswordConfig { 440 /** 441 * Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password. 442 */ 443 DeliveryMethod: DeliveryMethod; 444 /** 445 * The configuration for the email sent when an app user forgets their password. 446 */ 447 EmailSettings?: EmailSettings; 448 /** 449 * The configuration for the SMS message sent when an app user forgets their password. 450 */ 451 SmsSettings?: SmsSettings; 452 } 453 export interface CreateBackendAuthIdentityPoolConfig { 454 /** 455 * Name of the Amazon Cognito identity pool used for authorization. 456 */ 457 IdentityPoolName: __string; 458 /** 459 * Set to true or false based on whether you want to enable guest authorization to your Amplify app. 460 */ 461 UnauthenticatedLogin: __boolean; 462 } 463 export interface CreateBackendAuthMFAConfig { 464 /** 465 * Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project. 466 */ 467 MFAMode: MFAMode; 468 /** 469 * Describes the configuration settings and methods for your Amplify app users to use MFA. 470 */ 471 Settings?: Settings; 472 } 473 export interface CreateBackendAuthOAuthConfig { 474 /** 475 * The domain prefix for your Amplify app. 476 */ 477 DomainPrefix?: __string; 478 /** 479 * The OAuth grant type that you use to allow app users to authenticate from your Amplify app. 480 */ 481 OAuthGrantType: OAuthGrantType; 482 /** 483 * List of OAuth-related flows used to allow your app users to authenticate from your Amplify app. 484 */ 485 OAuthScopes: ListOfOAuthScopesElement; 486 /** 487 * The redirected URI for signing in to your Amplify app. 488 */ 489 RedirectSignInURIs: ListOf__string; 490 /** 491 * Redirect URLs that OAuth uses when a user signs out of an Amplify app. 492 */ 493 RedirectSignOutURIs: ListOf__string; 494 /** 495 * The settings for using social providers to access your Amplify app. 496 */ 497 SocialProviderSettings?: SocialProviderSettings; 498 } 499 export interface CreateBackendAuthPasswordPolicyConfig { 500 /** 501 * Additional constraints for the password used to access the backend of your Amplify project. 502 */ 503 AdditionalConstraints?: ListOfAdditionalConstraintsElement; 504 /** 505 * The minimum length of the password used to access the backend of your Amplify project. 506 */ 507 MinimumLength: __double; 508 } 509 export interface CreateBackendAuthRequest { 510 /** 511 * The app ID. 512 */ 513 AppId: __string; 514 /** 515 * The name of the backend environment. 516 */ 517 BackendEnvironmentName: __string; 518 /** 519 * The resource configuration for this request object. 520 */ 521 ResourceConfig: CreateBackendAuthResourceConfig; 522 /** 523 * The name of this resource. 524 */ 525 ResourceName: __string; 526 } 527 export interface CreateBackendAuthResourceConfig { 528 /** 529 * Defines whether you want to configure only authentication or both authentication and authorization settings. 530 */ 531 AuthResources: AuthResources; 532 /** 533 * Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. 534 */ 535 IdentityPoolConfigs?: CreateBackendAuthIdentityPoolConfig; 536 /** 537 * Defines the service name to use when configuring an authentication resource in your Amplify project. 538 */ 539 Service: Service; 540 /** 541 * Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. 542 */ 543 UserPoolConfigs: CreateBackendAuthUserPoolConfig; 544 } 545 export interface CreateBackendAuthResponse { 546 /** 547 * The app ID. 548 */ 549 AppId?: __string; 550 /** 551 * The name of the backend environment. 552 */ 553 BackendEnvironmentName?: __string; 554 /** 555 * If the request fails, this error is returned. 556 */ 557 Error?: __string; 558 /** 559 * The ID for the job. 560 */ 561 JobId?: __string; 562 /** 563 * The name of the operation. 564 */ 565 Operation?: __string; 566 /** 567 * The current status of the request. 568 */ 569 Status?: __string; 570 } 571 export interface CreateBackendAuthUserPoolConfig { 572 /** 573 * Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. 574 */ 575 ForgotPassword?: CreateBackendAuthForgotPasswordConfig; 576 /** 577 * Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project. 578 */ 579 Mfa?: CreateBackendAuthMFAConfig; 580 /** 581 * Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project. 582 */ 583 OAuth?: CreateBackendAuthOAuthConfig; 584 /** 585 * Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. 586 */ 587 PasswordPolicy?: CreateBackendAuthPasswordPolicyConfig; 588 /** 589 * The required attributes to sign up new users in the user pool. 590 */ 591 RequiredSignUpAttributes: ListOfRequiredSignUpAttributesElement; 592 /** 593 * Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project. 594 */ 595 SignInMethod: SignInMethod; 596 /** 597 * The Amazon Cognito user pool name. 598 */ 599 UserPoolName: __string; 600 } 601 export interface CreateBackendConfigRequest { 602 /** 603 * The app ID. 604 */ 605 AppId: __string; 606 /** 607 * The app ID for the backend manager. 608 */ 609 BackendManagerAppId?: __string; 610 } 611 export interface CreateBackendConfigResponse { 612 /** 613 * The app ID. 614 */ 615 AppId?: __string; 616 /** 617 * The name of the backend environment. 618 */ 619 BackendEnvironmentName?: __string; 620 /** 621 * The ID for the job. 622 */ 623 JobId?: __string; 624 /** 625 * The current status of the request. 626 */ 627 Status?: __string; 628 } 629 export interface CreateBackendRequest { 630 /** 631 * The app ID. 632 */ 633 AppId: __string; 634 /** 635 * The name of the app. 636 */ 637 AppName: __string; 638 /** 639 * The name of the backend environment. 640 */ 641 BackendEnvironmentName: __string; 642 /** 643 * The resource configuration for the create backend request. 644 */ 645 ResourceConfig?: ResourceConfig; 646 /** 647 * The name of the resource. 648 */ 649 ResourceName?: __string; 650 } 651 export interface CreateBackendResponse { 652 /** 653 * The app ID. 654 */ 655 AppId?: __string; 656 /** 657 * The name of the backend environment. 658 */ 659 BackendEnvironmentName?: __string; 660 /** 661 * If the request fails, this error is returned. 662 */ 663 Error?: __string; 664 /** 665 * The ID for the job. 666 */ 667 JobId?: __string; 668 /** 669 * The name of the operation. 670 */ 671 Operation?: __string; 672 /** 673 * The current status of the request. 674 */ 675 Status?: __string; 676 } 677 export interface CreateTokenRequest { 678 /** 679 * The app ID. 680 */ 681 AppId: __string; 682 } 683 export interface CreateTokenResponse { 684 /** 685 * The app ID. 686 */ 687 AppId?: __string; 688 /** 689 * One-time challenge code for authenticating into the Amplify Admin UI. 690 */ 691 ChallengeCode?: __string; 692 /** 693 * A unique ID provided when creating a new challenge token. 694 */ 695 SessionId?: __string; 696 /** 697 * The expiry time for the one-time generated token code. 698 */ 699 Ttl?: __string; 700 } 701 export interface DeleteBackendAPIRequest { 702 /** 703 * The app ID. 704 */ 705 AppId: __string; 706 /** 707 * The name of the backend environment. 708 */ 709 BackendEnvironmentName: __string; 710 /** 711 * Defines the resource configuration for the data model in your Amplify project. 712 */ 713 ResourceConfig?: BackendAPIResourceConfig; 714 /** 715 * The name of this resource. 716 */ 717 ResourceName: __string; 718 } 719 export interface DeleteBackendAPIResponse { 720 /** 721 * The app ID. 722 */ 723 AppId?: __string; 724 /** 725 * The name of the backend environment. 726 */ 727 BackendEnvironmentName?: __string; 728 /** 729 * If the request fails, this error is returned. 730 */ 731 Error?: __string; 732 /** 733 * The ID for the job. 734 */ 735 JobId?: __string; 736 /** 737 * The name of the operation. 738 */ 739 Operation?: __string; 740 /** 741 * The current status of the request. 742 */ 743 Status?: __string; 744 } 745 export interface DeleteBackendAuthRequest { 746 /** 747 * The app ID. 748 */ 749 AppId: __string; 750 /** 751 * The name of the backend environment. 752 */ 753 BackendEnvironmentName: __string; 754 /** 755 * The name of this resource. 756 */ 757 ResourceName: __string; 758 } 759 export interface DeleteBackendAuthResponse { 760 /** 761 * The app ID. 762 */ 763 AppId?: __string; 764 /** 765 * The name of the backend environment. 766 */ 767 BackendEnvironmentName?: __string; 768 /** 769 * If the request fails, this error is returned. 770 */ 771 Error?: __string; 772 /** 773 * The ID for the job. 774 */ 775 JobId?: __string; 776 /** 777 * The name of the operation. 778 */ 779 Operation?: __string; 780 /** 781 * The current status of the request. 782 */ 783 Status?: __string; 784 } 785 export interface DeleteBackendRequest { 786 /** 787 * The app ID. 788 */ 789 AppId: __string; 790 /** 791 * The name of the backend environment. 792 */ 793 BackendEnvironmentName: __string; 794 } 795 export interface DeleteBackendResponse { 796 /** 797 * The app ID. 798 */ 799 AppId?: __string; 800 /** 801 * The name of the backend environment. 802 */ 803 BackendEnvironmentName?: __string; 804 /** 805 * If the request fails, this error is returned. 806 */ 807 Error?: __string; 808 /** 809 * The ID for the job. 810 */ 811 JobId?: __string; 812 /** 813 * The name of the operation. 814 */ 815 Operation?: __string; 816 /** 817 * The current status of the request. 818 */ 819 Status?: __string; 820 } 821 export interface DeleteTokenRequest { 822 /** 823 * The app ID. 824 */ 825 AppId: __string; 826 /** 827 * The session ID. 828 */ 829 SessionId: __string; 830 } 831 export interface DeleteTokenResponse { 832 /** 833 * Indicates whether the request succeeded or failed. 834 */ 835 IsSuccess?: __boolean; 836 } 837 export type DeliveryMethod = "EMAIL"|"SMS"|string; 838 export interface EmailSettings { 839 /** 840 * The body of the email. 841 */ 842 EmailMessage?: __string; 843 /** 844 * The subject of the email. 845 */ 846 EmailSubject?: __string; 847 } 848 export interface GenerateBackendAPIModelsRequest { 849 /** 850 * The app ID. 851 */ 852 AppId: __string; 853 /** 854 * The name of the backend environment. 855 */ 856 BackendEnvironmentName: __string; 857 /** 858 * The name of this resource. 859 */ 860 ResourceName: __string; 861 } 862 export interface GenerateBackendAPIModelsResponse { 863 /** 864 * The app ID. 865 */ 866 AppId?: __string; 867 /** 868 * The name of the backend environment. 869 */ 870 BackendEnvironmentName?: __string; 871 /** 872 * If the request fails, this error is returned. 873 */ 874 Error?: __string; 875 /** 876 * The ID for the job. 877 */ 878 JobId?: __string; 879 /** 880 * The name of the operation. 881 */ 882 Operation?: __string; 883 /** 884 * The current status of the request. 885 */ 886 Status?: __string; 887 } 888 export interface GetBackendAPIModelsRequest { 889 /** 890 * The app ID. 891 */ 892 AppId: __string; 893 /** 894 * The name of the backend environment. 895 */ 896 BackendEnvironmentName: __string; 897 /** 898 * The name of this resource. 899 */ 900 ResourceName: __string; 901 } 902 export interface GetBackendAPIModelsResponse { 903 /** 904 * Stringified JSON of the datastore model. 905 */ 906 Models?: __string; 907 /** 908 * The current status of the request. 909 */ 910 Status?: Status; 911 } 912 export interface GetBackendAPIRequest { 913 /** 914 * The app ID. 915 */ 916 AppId: __string; 917 /** 918 * The name of the backend environment. 919 */ 920 BackendEnvironmentName: __string; 921 /** 922 * Defines the resource configuration for the data model in your Amplify project. 923 */ 924 ResourceConfig?: BackendAPIResourceConfig; 925 /** 926 * The name of this resource. 927 */ 928 ResourceName: __string; 929 } 930 export interface GetBackendAPIResponse { 931 /** 932 * The app ID. 933 */ 934 AppId?: __string; 935 /** 936 * The name of the backend environment. 937 */ 938 BackendEnvironmentName?: __string; 939 /** 940 * If the request fails, this error is returned. 941 */ 942 Error?: __string; 943 /** 944 * The resource configuration for this response object. 945 */ 946 ResourceConfig?: BackendAPIResourceConfig; 947 /** 948 * The name of this resource. 949 */ 950 ResourceName?: __string; 951 } 952 export interface GetBackendAuthRequest { 953 /** 954 * The app ID. 955 */ 956 AppId: __string; 957 /** 958 * The name of the backend environment. 959 */ 960 BackendEnvironmentName: __string; 961 /** 962 * The name of this resource. 963 */ 964 ResourceName: __string; 965 } 966 export interface GetBackendAuthResponse { 967 /** 968 * The app ID. 969 */ 970 AppId?: __string; 971 /** 972 * The name of the backend environment. 973 */ 974 BackendEnvironmentName?: __string; 975 /** 976 * If the request fails, this error is returned. 977 */ 978 Error?: __string; 979 /** 980 * The resource configuration for authorization requests to the backend of your Amplify project. 981 */ 982 ResourceConfig?: CreateBackendAuthResourceConfig; 983 /** 984 * The name of this resource. 985 */ 986 ResourceName?: __string; 987 } 988 export interface GetBackendJobRequest { 989 /** 990 * The app ID. 991 */ 992 AppId: __string; 993 /** 994 * The name of the backend environment. 995 */ 996 BackendEnvironmentName: __string; 997 /** 998 * The ID for the job. 999 */ 1000 JobId: __string; 1001 } 1002 export interface GetBackendJobResponse { 1003 /** 1004 * The app ID. 1005 */ 1006 AppId?: __string; 1007 /** 1008 * The name of the backend environment. 1009 */ 1010 BackendEnvironmentName?: __string; 1011 /** 1012 * The time when the job was created. 1013 */ 1014 CreateTime?: __string; 1015 /** 1016 * If the request fails, this error is returned. 1017 */ 1018 Error?: __string; 1019 /** 1020 * The ID for the job. 1021 */ 1022 JobId?: __string; 1023 /** 1024 * The name of the operation. 1025 */ 1026 Operation?: __string; 1027 /** 1028 * The current status of the request. 1029 */ 1030 Status?: __string; 1031 /** 1032 * The time when the job was last updated. 1033 */ 1034 UpdateTime?: __string; 1035 } 1036 export interface GetBackendRequest { 1037 /** 1038 * The app ID. 1039 */ 1040 AppId: __string; 1041 /** 1042 * The name of the backend environment. 1043 */ 1044 BackendEnvironmentName?: __string; 1045 } 1046 export interface GetBackendResponse { 1047 /** 1048 * A stringified version of the current configs for your Amplify project. 1049 */ 1050 AmplifyMetaConfig?: __string; 1051 /** 1052 * The app ID. 1053 */ 1054 AppId?: __string; 1055 /** 1056 * The name of the app. 1057 */ 1058 AppName?: __string; 1059 /** 1060 * A list of backend environments in an array. 1061 */ 1062 BackendEnvironmentList?: ListOf__string; 1063 /** 1064 * The name of the backend environment. 1065 */ 1066 BackendEnvironmentName?: __string; 1067 /** 1068 * If the request failed, this is the returned error. 1069 */ 1070 Error?: __string; 1071 } 1072 export interface GetTokenRequest { 1073 /** 1074 * The app ID. 1075 */ 1076 AppId: __string; 1077 /** 1078 * The session ID. 1079 */ 1080 SessionId: __string; 1081 } 1082 export interface GetTokenResponse { 1083 /** 1084 * The app ID. 1085 */ 1086 AppId?: __string; 1087 /** 1088 * The one-time challenge code for authenticating into the Amplify Admin UI. 1089 */ 1090 ChallengeCode?: __string; 1091 /** 1092 * A unique ID provided when creating a new challenge token. 1093 */ 1094 SessionId?: __string; 1095 /** 1096 * The expiry time for the one-time generated token code. 1097 */ 1098 Ttl?: __string; 1099 } 1100 export interface ImportBackendAuthRequest { 1101 /** 1102 * The app ID. 1103 */ 1104 AppId: __string; 1105 /** 1106 * The name of the backend environment. 1107 */ 1108 BackendEnvironmentName: __string; 1109 /** 1110 * The ID of the Amazon Cognito identity pool. 1111 */ 1112 IdentityPoolId?: __string; 1113 /** 1114 * The ID of the Amazon Cognito native client. 1115 */ 1116 NativeClientId: __string; 1117 /** 1118 * The ID of the Amazon Cognito user pool. 1119 */ 1120 UserPoolId: __string; 1121 /** 1122 * The ID of the Amazon Cognito web client. 1123 */ 1124 WebClientId: __string; 1125 } 1126 export interface ImportBackendAuthResponse { 1127 /** 1128 * The app ID. 1129 */ 1130 AppId?: __string; 1131 /** 1132 * The name of the backend environment. 1133 */ 1134 BackendEnvironmentName?: __string; 1135 /** 1136 * If the request fails, this error is returned. 1137 */ 1138 Error?: __string; 1139 /** 1140 * The ID for the job. 1141 */ 1142 JobId?: __string; 1143 /** 1144 * The name of the operation. 1145 */ 1146 Operation?: __string; 1147 /** 1148 * The current status of the request. 1149 */ 1150 Status?: __string; 1151 } 1152 export interface ListBackendJobsRequest { 1153 /** 1154 * The app ID. 1155 */ 1156 AppId: __string; 1157 /** 1158 * The name of the backend environment. 1159 */ 1160 BackendEnvironmentName: __string; 1161 /** 1162 * The ID for the job. 1163 */ 1164 JobId?: __string; 1165 /** 1166 * The maximum number of results that you want in the response. 1167 */ 1168 MaxResults?: __integerMin1Max25; 1169 /** 1170 * The token for the next set of results. 1171 */ 1172 NextToken?: __string; 1173 /** 1174 * Filters the list of response objects to include only those with the specified operation name. 1175 */ 1176 Operation?: __string; 1177 /** 1178 * Filters the list of response objects to include only those with the specified status. 1179 */ 1180 Status?: __string; 1181 } 1182 export interface ListBackendJobsResponse { 1183 /** 1184 * An array of jobs and their properties. 1185 */ 1186 Jobs?: ListOfBackendJobRespObj; 1187 /** 1188 * The token for the next set of results. 1189 */ 1190 NextToken?: __string; 1191 } 1192 export interface LoginAuthConfigReqObj { 1193 /** 1194 * The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization. 1195 */ 1196 AwsCognitoIdentityPoolId?: __string; 1197 /** 1198 * The AWS Region for the Amplify Admin UI login. 1199 */ 1200 AwsCognitoRegion?: __string; 1201 /** 1202 * The Amazon Cognito user pool ID used for Amplify Admin UI login authentication. 1203 */ 1204 AwsUserPoolsId?: __string; 1205 /** 1206 * The web client ID for the Amazon Cognito user pools. 1207 */ 1208 AwsUserPoolsWebClientId?: __string; 1209 } 1210 export type MFAMode = "ON"|"OFF"|"OPTIONAL"|string; 1211 export type Mode = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|string; 1212 export type OAuthGrantType = "CODE"|"IMPLICIT"|string; 1213 export interface RemoveAllBackendsRequest { 1214 /** 1215 * The app ID. 1216 */ 1217 AppId: __string; 1218 /** 1219 * Cleans up the Amplify Console app if this value is set to true. 1220 */ 1221 CleanAmplifyApp?: __boolean; 1222 } 1223 export interface RemoveAllBackendsResponse { 1224 /** 1225 * The app ID. 1226 */ 1227 AppId?: __string; 1228 /** 1229 * If the request fails, this error is returned. 1230 */ 1231 Error?: __string; 1232 /** 1233 * The ID for the job. 1234 */ 1235 JobId?: __string; 1236 /** 1237 * The name of the operation. 1238 */ 1239 Operation?: __string; 1240 /** 1241 * The current status of the request. 1242 */ 1243 Status?: __string; 1244 } 1245 export interface RemoveBackendConfigRequest { 1246 /** 1247 * The app ID. 1248 */ 1249 AppId: __string; 1250 } 1251 export interface RemoveBackendConfigResponse { 1252 /** 1253 * If the request fails, this error is returned. 1254 */ 1255 Error?: __string; 1256 } 1257 export type ResolutionStrategy = "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"|string; 1258 export interface ResourceConfig { 1259 } 1260 export type Service = "COGNITO"|string; 1261 export interface Settings { 1262 /** 1263 * The supported MFA types. 1264 */ 1265 MfaTypes?: ListOfMfaTypesElement; 1266 /** 1267 * The body of the SMS message. 1268 */ 1269 SmsMessage?: __string; 1270 } 1271 export type SignInMethod = "EMAIL"|"EMAIL_AND_PHONE_NUMBER"|"PHONE_NUMBER"|"USERNAME"|string; 1272 export interface SmsSettings { 1273 /** 1274 * The body of the SMS message. 1275 */ 1276 SmsMessage?: __string; 1277 } 1278 export interface SocialProviderSettings { 1279 Facebook?: BackendAuthSocialProviderConfig; 1280 Google?: BackendAuthSocialProviderConfig; 1281 LoginWithAmazon?: BackendAuthSocialProviderConfig; 1282 SignInWithApple?: BackendAuthAppleProviderConfig; 1283 } 1284 export type Status = "LATEST"|"STALE"|string; 1285 export interface UpdateBackendAPIRequest { 1286 /** 1287 * The app ID. 1288 */ 1289 AppId: __string; 1290 /** 1291 * The name of the backend environment. 1292 */ 1293 BackendEnvironmentName: __string; 1294 /** 1295 * Defines the resource configuration for the data model in your Amplify project. 1296 */ 1297 ResourceConfig?: BackendAPIResourceConfig; 1298 /** 1299 * The name of this resource. 1300 */ 1301 ResourceName: __string; 1302 } 1303 export interface UpdateBackendAPIResponse { 1304 /** 1305 * The app ID. 1306 */ 1307 AppId?: __string; 1308 /** 1309 * The name of the backend environment. 1310 */ 1311 BackendEnvironmentName?: __string; 1312 /** 1313 * If the request fails, this error is returned. 1314 */ 1315 Error?: __string; 1316 /** 1317 * The ID for the job. 1318 */ 1319 JobId?: __string; 1320 /** 1321 * The name of the operation. 1322 */ 1323 Operation?: __string; 1324 /** 1325 * The current status of the request. 1326 */ 1327 Status?: __string; 1328 } 1329 export interface UpdateBackendAuthForgotPasswordConfig { 1330 /** 1331 * Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password. 1332 */ 1333 DeliveryMethod?: DeliveryMethod; 1334 /** 1335 * The configuration for the email sent when an app user forgets their password. 1336 */ 1337 EmailSettings?: EmailSettings; 1338 /** 1339 * The configuration for the SMS message sent when an Amplify app user forgets their password. 1340 */ 1341 SmsSettings?: SmsSettings; 1342 } 1343 export interface UpdateBackendAuthIdentityPoolConfig { 1344 /** 1345 * A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app. 1346 */ 1347 UnauthenticatedLogin?: __boolean; 1348 } 1349 export interface UpdateBackendAuthMFAConfig { 1350 /** 1351 * The MFA mode for the backend of your Amplify project. 1352 */ 1353 MFAMode?: MFAMode; 1354 /** 1355 * The settings of your MFA configuration for the backend of your Amplify project. 1356 */ 1357 Settings?: Settings; 1358 } 1359 export interface UpdateBackendAuthOAuthConfig { 1360 /** 1361 * The Amazon Cognito domain prefix used to create a hosted UI for authentication. 1362 */ 1363 DomainPrefix?: __string; 1364 /** 1365 * The OAuth grant type to allow app users to authenticate from your Amplify app. 1366 */ 1367 OAuthGrantType?: OAuthGrantType; 1368 /** 1369 * The list of OAuth-related flows that can allow users to authenticate from your Amplify app. 1370 */ 1371 OAuthScopes?: ListOfOAuthScopesElement; 1372 /** 1373 * Redirect URLs that OAuth uses when a user signs in to an Amplify app. 1374 */ 1375 RedirectSignInURIs?: ListOf__string; 1376 /** 1377 * Redirect URLs that OAuth uses when a user signs out of an Amplify app. 1378 */ 1379 RedirectSignOutURIs?: ListOf__string; 1380 /** 1381 * Describes third-party social federation configurations for allowing your users to sign in with OAuth. 1382 */ 1383 SocialProviderSettings?: SocialProviderSettings; 1384 } 1385 export interface UpdateBackendAuthPasswordPolicyConfig { 1386 /** 1387 * Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project. 1388 */ 1389 AdditionalConstraints?: ListOfAdditionalConstraintsElement; 1390 /** 1391 * Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project. 1392 */ 1393 MinimumLength?: __double; 1394 } 1395 export interface UpdateBackendAuthRequest { 1396 /** 1397 * The app ID. 1398 */ 1399 AppId: __string; 1400 /** 1401 * The name of the backend environment. 1402 */ 1403 BackendEnvironmentName: __string; 1404 /** 1405 * The resource configuration for this request object. 1406 */ 1407 ResourceConfig: UpdateBackendAuthResourceConfig; 1408 /** 1409 * The name of this resource. 1410 */ 1411 ResourceName: __string; 1412 } 1413 export interface UpdateBackendAuthResourceConfig { 1414 /** 1415 * Defines the service name to use when configuring an authentication resource in your Amplify project. 1416 */ 1417 AuthResources: AuthResources; 1418 /** 1419 * Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. 1420 */ 1421 IdentityPoolConfigs?: UpdateBackendAuthIdentityPoolConfig; 1422 /** 1423 * Defines the service name to use when configuring an authentication resource in your Amplify project. 1424 */ 1425 Service: Service; 1426 /** 1427 * Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. 1428 */ 1429 UserPoolConfigs: UpdateBackendAuthUserPoolConfig; 1430 } 1431 export interface UpdateBackendAuthResponse { 1432 /** 1433 * The app ID. 1434 */ 1435 AppId?: __string; 1436 /** 1437 * The name of the backend environment. 1438 */ 1439 BackendEnvironmentName?: __string; 1440 /** 1441 * If the request fails, this error is returned. 1442 */ 1443 Error?: __string; 1444 /** 1445 * The ID for the job. 1446 */ 1447 JobId?: __string; 1448 /** 1449 * The name of the operation. 1450 */ 1451 Operation?: __string; 1452 /** 1453 * The current status of the request. 1454 */ 1455 Status?: __string; 1456 } 1457 export interface UpdateBackendAuthUserPoolConfig { 1458 /** 1459 * Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. 1460 */ 1461 ForgotPassword?: UpdateBackendAuthForgotPasswordConfig; 1462 /** 1463 * Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project. 1464 */ 1465 Mfa?: UpdateBackendAuthMFAConfig; 1466 /** 1467 * Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project. 1468 */ 1469 OAuth?: UpdateBackendAuthOAuthConfig; 1470 /** 1471 * Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. 1472 */ 1473 PasswordPolicy?: UpdateBackendAuthPasswordPolicyConfig; 1474 } 1475 export interface UpdateBackendConfigRequest { 1476 /** 1477 * The app ID. 1478 */ 1479 AppId: __string; 1480 /** 1481 * Describes the Amazon Cognito configuration for Admin UI access. 1482 */ 1483 LoginAuthConfig?: LoginAuthConfigReqObj; 1484 } 1485 export interface UpdateBackendConfigResponse { 1486 /** 1487 * The app ID. 1488 */ 1489 AppId?: __string; 1490 /** 1491 * The app ID for the backend manager. 1492 */ 1493 BackendManagerAppId?: __string; 1494 /** 1495 * If the request fails, this error is returned. 1496 */ 1497 Error?: __string; 1498 /** 1499 * Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with. 1500 */ 1501 LoginAuthConfig?: LoginAuthConfigReqObj; 1502 } 1503 export interface UpdateBackendJobRequest { 1504 /** 1505 * The app ID. 1506 */ 1507 AppId: __string; 1508 /** 1509 * The name of the backend environment. 1510 */ 1511 BackendEnvironmentName: __string; 1512 /** 1513 * The ID for the job. 1514 */ 1515 JobId: __string; 1516 /** 1517 * Filters the list of response objects to include only those with the specified operation name. 1518 */ 1519 Operation?: __string; 1520 /** 1521 * Filters the list of response objects to include only those with the specified status. 1522 */ 1523 Status?: __string; 1524 } 1525 export interface UpdateBackendJobResponse { 1526 /** 1527 * The app ID. 1528 */ 1529 AppId?: __string; 1530 /** 1531 * The name of the backend environment. 1532 */ 1533 BackendEnvironmentName?: __string; 1534 /** 1535 * The time when the job was created. 1536 */ 1537 CreateTime?: __string; 1538 /** 1539 * If the request fails, this error is returned. 1540 */ 1541 Error?: __string; 1542 /** 1543 * The ID for the job. 1544 */ 1545 JobId?: __string; 1546 /** 1547 * The name of the operation. 1548 */ 1549 Operation?: __string; 1550 /** 1551 * The current status of the request. 1552 */ 1553 Status?: __string; 1554 /** 1555 * The time when the job was last updated. 1556 */ 1557 UpdateTime?: __string; 1558 } 1559 export type AdditionalConstraintsElement = "REQUIRE_DIGIT"|"REQUIRE_LOWERCASE"|"REQUIRE_SYMBOL"|"REQUIRE_UPPERCASE"|string; 1560 export type MfaTypesElement = "SMS"|"TOTP"|string; 1561 export type OAuthScopesElement = "PHONE"|"EMAIL"|"OPENID"|"PROFILE"|"AWS_COGNITO_SIGNIN_USER_ADMIN"|string; 1562 export type RequiredSignUpAttributesElement = "ADDRESS"|"BIRTHDATE"|"EMAIL"|"FAMILY_NAME"|"GENDER"|"GIVEN_NAME"|"LOCALE"|"MIDDLE_NAME"|"NAME"|"NICKNAME"|"PHONE_NUMBER"|"PICTURE"|"PREFERRED_USERNAME"|"PROFILE"|"UPDATED_AT"|"WEBSITE"|"ZONE_INFO"|string; 1563 export type __boolean = boolean; 1564 export type __double = number; 1565 export type __integerMin1Max25 = number; 1566 export type ListOfBackendAPIAuthType = BackendAPIAuthType[]; 1567 export type ListOfBackendJobRespObj = BackendJobRespObj[]; 1568 export type ListOfAdditionalConstraintsElement = AdditionalConstraintsElement[]; 1569 export type ListOfMfaTypesElement = MfaTypesElement[]; 1570 export type ListOfOAuthScopesElement = OAuthScopesElement[]; 1571 export type ListOfRequiredSignUpAttributesElement = RequiredSignUpAttributesElement[]; 1572 export type ListOf__string = __string[]; 1573 export type __string = string; 1574 /** 1575 * 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. 1576 */ 1577 export type apiVersion = "2020-08-11"|"latest"|string; 1578 export interface ClientApiVersions { 1579 /** 1580 * 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. 1581 */ 1582 apiVersion?: apiVersion; 1583 } 1584 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1585 /** 1586 * Contains interfaces for use with the AmplifyBackend client. 1587 */ 1588 export import Types = AmplifyBackend; 1589 } 1590 export = AmplifyBackend;