UNPKG

34.2 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Amplify extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Amplify.Types.ClientConfiguration)
13 config: Config & Amplify.Types.ClientConfiguration;
14 /**
15 * Creates a new Amplify App.
16 */
17 createApp(params: Amplify.Types.CreateAppRequest, callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request<Amplify.Types.CreateAppResult, AWSError>;
18 /**
19 * Creates a new Amplify App.
20 */
21 createApp(callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request<Amplify.Types.CreateAppResult, AWSError>;
22 /**
23 * Creates a new Branch for an Amplify App.
24 */
25 createBranch(params: Amplify.Types.CreateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request<Amplify.Types.CreateBranchResult, AWSError>;
26 /**
27 * Creates a new Branch for an Amplify App.
28 */
29 createBranch(callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request<Amplify.Types.CreateBranchResult, AWSError>;
30 /**
31 * Create a new DomainAssociation on an App
32 */
33 createDomainAssociation(params: Amplify.Types.CreateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>;
34 /**
35 * Create a new DomainAssociation on an App
36 */
37 createDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>;
38 /**
39 * Delete an existing Amplify App by appId.
40 */
41 deleteApp(params: Amplify.Types.DeleteAppRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>;
42 /**
43 * Delete an existing Amplify App by appId.
44 */
45 deleteApp(callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>;
46 /**
47 * Deletes a branch for an Amplify App.
48 */
49 deleteBranch(params: Amplify.Types.DeleteBranchRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>;
50 /**
51 * Deletes a branch for an Amplify App.
52 */
53 deleteBranch(callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>;
54 /**
55 * Deletes a DomainAssociation.
56 */
57 deleteDomainAssociation(params: Amplify.Types.DeleteDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>;
58 /**
59 * Deletes a DomainAssociation.
60 */
61 deleteDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>;
62 /**
63 * Delete a job, for an Amplify branch, part of Amplify App.
64 */
65 deleteJob(params: Amplify.Types.DeleteJobRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>;
66 /**
67 * Delete a job, for an Amplify branch, part of Amplify App.
68 */
69 deleteJob(callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>;
70 /**
71 * Retrieves an existing Amplify App by appId.
72 */
73 getApp(params: Amplify.Types.GetAppRequest, callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>;
74 /**
75 * Retrieves an existing Amplify App by appId.
76 */
77 getApp(callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>;
78 /**
79 * Retrieves a branch for an Amplify App.
80 */
81 getBranch(params: Amplify.Types.GetBranchRequest, callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>;
82 /**
83 * Retrieves a branch for an Amplify App.
84 */
85 getBranch(callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>;
86 /**
87 * Retrieves domain info that corresponds to an appId and domainName.
88 */
89 getDomainAssociation(params: Amplify.Types.GetDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>;
90 /**
91 * Retrieves domain info that corresponds to an appId and domainName.
92 */
93 getDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>;
94 /**
95 * Get a job for a branch, part of an Amplify App.
96 */
97 getJob(params: Amplify.Types.GetJobRequest, callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>;
98 /**
99 * Get a job for a branch, part of an Amplify App.
100 */
101 getJob(callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>;
102 /**
103 * Lists existing Amplify Apps.
104 */
105 listApps(params: Amplify.Types.ListAppsRequest, callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>;
106 /**
107 * Lists existing Amplify Apps.
108 */
109 listApps(callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>;
110 /**
111 * Lists branches for an Amplify App.
112 */
113 listBranches(params: Amplify.Types.ListBranchesRequest, callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>;
114 /**
115 * Lists branches for an Amplify App.
116 */
117 listBranches(callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>;
118 /**
119 * List domains with an app
120 */
121 listDomainAssociations(params: Amplify.Types.ListDomainAssociationsRequest, callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>;
122 /**
123 * List domains with an app
124 */
125 listDomainAssociations(callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>;
126 /**
127 * List Jobs for a branch, part of an Amplify App.
128 */
129 listJobs(params: Amplify.Types.ListJobsRequest, callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>;
130 /**
131 * List Jobs for a branch, part of an Amplify App.
132 */
133 listJobs(callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>;
134 /**
135 * Starts a new job for a branch, part of an Amplify App.
136 */
137 startJob(params: Amplify.Types.StartJobRequest, callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>;
138 /**
139 * Starts a new job for a branch, part of an Amplify App.
140 */
141 startJob(callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>;
142 /**
143 * Stop a job that is in progress, for an Amplify branch, part of Amplify App.
144 */
145 stopJob(params: Amplify.Types.StopJobRequest, callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>;
146 /**
147 * Stop a job that is in progress, for an Amplify branch, part of Amplify App.
148 */
149 stopJob(callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>;
150 /**
151 * Updates an existing Amplify App.
152 */
153 updateApp(params: Amplify.Types.UpdateAppRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>;
154 /**
155 * Updates an existing Amplify App.
156 */
157 updateApp(callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>;
158 /**
159 * Updates a branch for an Amplify App.
160 */
161 updateBranch(params: Amplify.Types.UpdateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>;
162 /**
163 * Updates a branch for an Amplify App.
164 */
165 updateBranch(callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>;
166 /**
167 * Create a new DomainAssociation on an App
168 */
169 updateDomainAssociation(params: Amplify.Types.UpdateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>;
170 /**
171 * Create a new DomainAssociation on an App
172 */
173 updateDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>;
174}
175declare namespace Amplify {
176 export type ActiveJobId = string;
177 export interface App {
178 /**
179 * Unique Id for the Amplify App.
180 */
181 appId: AppId;
182 /**
183 * ARN for the Amplify App.
184 */
185 appArn: AppArn;
186 /**
187 * Name for the Amplify App.
188 */
189 name: Name;
190 /**
191 * Tag for Amplify App.
192 */
193 tags?: Tags;
194 /**
195 * Description for the Amplify App.
196 */
197 description: Description;
198 /**
199 * Repository for the Amplify App.
200 */
201 repository: Repository;
202 /**
203 * Platform for the Amplify App.
204 */
205 platform: Platform;
206 /**
207 * Create date / time for the Amplify App.
208 */
209 createTime: CreateTime;
210 /**
211 * Update date / time for the Amplify App.
212 */
213 updateTime: UpdateTime;
214 /**
215 * IAM service role ARN for the Amplify App.
216 */
217 iamServiceRoleArn?: ServiceRoleArn;
218 /**
219 * Environment Variables for the Amplify App.
220 */
221 environmentVariables: EnvironmentVariables;
222 /**
223 * Default domain for the Amplify App.
224 */
225 defaultDomain: DefaultDomain;
226 /**
227 * Enables auto-building of branches for the Amplify App.
228 */
229 enableBranchAutoBuild: EnableBranchAutoBuild;
230 /**
231 * Enables Basic Authorization for branches for the Amplify App.
232 */
233 enableBasicAuth: EnableBasicAuth;
234 /**
235 * Basic Authorization credentials for branches for the Amplify App.
236 */
237 basicAuthCredentials?: BasicAuthCredentials;
238 /**
239 * Custom redirect / rewrite rules for the Amplify App.
240 */
241 customRules?: CustomRules;
242 /**
243 * Structure with Production Branch information.
244 */
245 productionBranch?: ProductionBranch;
246 /**
247 * BuildSpec content for Amplify App.
248 */
249 buildSpec?: BuildSpec;
250 }
251 export type AppArn = string;
252 export type AppId = string;
253 export type Apps = App[];
254 export type ArtifactsUrl = string;
255 export type BasicAuthCredentials = string;
256 export interface Branch {
257 /**
258 * ARN for a branch, part of an Amplify App.
259 */
260 branchArn: BranchArn;
261 /**
262 * Name for a branch, part of an Amplify App.
263 */
264 branchName: BranchName;
265 /**
266 * Description for a branch, part of an Amplify App.
267 */
268 description: Description;
269 /**
270 * Tag for branch for Amplify App.
271 */
272 tags?: Tags;
273 /**
274 * Stage for a branch, part of an Amplify App.
275 */
276 stage: Stage;
277 /**
278 * Display name for a branch, part of an Amplify App.
279 */
280 displayName?: DisplayName;
281 /**
282 * Enables notifications for a branch, part of an Amplify App.
283 */
284 enableNotification: EnableNotification;
285 /**
286 * Creation date and time for a branch, part of an Amplify App.
287 */
288 createTime: CreateTime;
289 /**
290 * Last updated date and time for a branch, part of an Amplify App.
291 */
292 updateTime: UpdateTime;
293 /**
294 * Environment Variables specific to a branch, part of an Amplify App.
295 */
296 environmentVariables: EnvironmentVariables;
297 /**
298 * Enables auto-building on push for a branch, part of an Amplify App.
299 */
300 enableAutoBuild: EnableAutoBuild;
301 /**
302 * Custom domains for a branch, part of an Amplify App.
303 */
304 customDomains: CustomDomains;
305 /**
306 * Framework for a branch, part of an Amplify App.
307 */
308 framework: Framework;
309 /**
310 * Id of the active job for a branch, part of an Amplify App.
311 */
312 activeJobId: ActiveJobId;
313 /**
314 * Total number of Jobs part of an Amplify App.
315 */
316 totalNumberOfJobs: TotalNumberOfJobs;
317 /**
318 * Enables Basic Authorization for a branch, part of an Amplify App.
319 */
320 enableBasicAuth: EnableBasicAuth;
321 /**
322 * Thumbnail Url for the branch.
323 */
324 thumbnailUrl?: ThumbnailUrl;
325 /**
326 * Basic Authorization credentials for a branch, part of an Amplify App.
327 */
328 basicAuthCredentials?: BasicAuthCredentials;
329 /**
330 * BuildSpec content for branch for Amplify App.
331 */
332 buildSpec?: BuildSpec;
333 /**
334 * The content TTL for the website in seconds.
335 */
336 ttl: TTL;
337 }
338 export type BranchArn = string;
339 export type BranchName = string;
340 export type Branches = Branch[];
341 export type BuildSpec = string;
342 export type CertificateVerificationDNSRecord = string;
343 export type CommitId = string;
344 export type CommitMessage = string;
345 export type CommitTime = Date;
346 export type Condition = string;
347 export interface CreateAppRequest {
348 /**
349 * Name for the Amplify App
350 */
351 name: Name;
352 /**
353 * Description for an Amplify App
354 */
355 description?: Description;
356 /**
357 * Repository for an Amplify App
358 */
359 repository: Repository;
360 /**
361 * Platform / framework for an Amplify App
362 */
363 platform: Platform;
364 /**
365 * AWS IAM service role for an Amplify App
366 */
367 iamServiceRoleArn?: ServiceRoleArn;
368 /**
369 * OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.
370 */
371 oauthToken: OauthToken;
372 /**
373 * Environment variables map for an Amplify App.
374 */
375 environmentVariables?: EnvironmentVariables;
376 /**
377 * Enable the auto building of branches for an Amplify App.
378 */
379 enableBranchAutoBuild?: EnableBranchAutoBuild;
380 /**
381 * Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
382 */
383 enableBasicAuth?: EnableBasicAuth;
384 /**
385 * Credentials for Basic Authorization for an Amplify App.
386 */
387 basicAuthCredentials?: BasicAuthCredentials;
388 /**
389 * Custom rewrite / redirect rules for an Amplify App.
390 */
391 customRules?: CustomRules;
392 /**
393 * Tag for an Amplify App
394 */
395 tags?: Tags;
396 /**
397 * BuildSpec for an Amplify App
398 */
399 buildSpec?: BuildSpec;
400 }
401 export interface CreateAppResult {
402 app: App;
403 }
404 export interface CreateBranchRequest {
405 /**
406 * Unique Id for an Amplify App.
407 */
408 appId: AppId;
409 /**
410 * Name for the branch.
411 */
412 branchName: BranchName;
413 /**
414 * Description for the branch.
415 */
416 description?: Description;
417 /**
418 * Stage for the branch.
419 */
420 stage?: Stage;
421 /**
422 * Framework for the branch.
423 */
424 framework?: Framework;
425 /**
426 * Enables notifications for the branch.
427 */
428 enableNotification?: EnableNotification;
429 /**
430 * Enables auto building for the branch.
431 */
432 enableAutoBuild?: EnableAutoBuild;
433 /**
434 * Environment Variables for the branch.
435 */
436 environmentVariables?: EnvironmentVariables;
437 /**
438 * Basic Authorization credentials for the branch.
439 */
440 basicAuthCredentials?: BasicAuthCredentials;
441 /**
442 * Enables Basic Auth for the branch.
443 */
444 enableBasicAuth?: EnableBasicAuth;
445 /**
446 * Tag for the branch.
447 */
448 tags?: Tags;
449 /**
450 * BuildSpec for the branch.
451 */
452 buildSpec?: BuildSpec;
453 /**
454 * The content TTL for the website in seconds.
455 */
456 ttl?: TTL;
457 }
458 export interface CreateBranchResult {
459 /**
460 * Branch structure for an Amplify App.
461 */
462 branch: Branch;
463 }
464 export interface CreateDomainAssociationRequest {
465 /**
466 * Unique Id for an Amplify App.
467 */
468 appId: AppId;
469 /**
470 * Domain name for the Domain Association.
471 */
472 domainName: DomainName;
473 /**
474 * Enables automated creation of Subdomains for branches.
475 */
476 enableAutoSubDomain?: EnableAutoSubDomain;
477 /**
478 * Setting structure for the Subdomain.
479 */
480 subDomainSettings: SubDomainSettings;
481 }
482 export interface CreateDomainAssociationResult {
483 /**
484 * Domain Association structure.
485 */
486 domainAssociation: DomainAssociation;
487 }
488 export type CreateTime = Date;
489 export type CustomDomain = string;
490 export type CustomDomains = CustomDomain[];
491 export interface CustomRule {
492 /**
493 * The source pattern for a URL rewrite or redirect rule.
494 */
495 source: Source;
496 /**
497 * The target pattern for a URL rewrite or redirect rule.
498 */
499 target: Target;
500 /**
501 * The status code for a URL rewrite or redirect rule.
502 */
503 status?: Status;
504 /**
505 * The condition for a URL rewrite or redirect rule, e.g. country code.
506 */
507 condition?: Condition;
508 }
509 export type CustomRules = CustomRule[];
510 export type DNSRecord = string;
511 export type DefaultDomain = string;
512 export interface DeleteAppRequest {
513 /**
514 * Unique Id for an Amplify App.
515 */
516 appId: AppId;
517 }
518 export interface DeleteAppResult {
519 app: App;
520 }
521 export interface DeleteBranchRequest {
522 /**
523 * Unique Id for an Amplify App.
524 */
525 appId: AppId;
526 /**
527 * Name for the branch.
528 */
529 branchName: BranchName;
530 }
531 export interface DeleteBranchResult {
532 /**
533 * Branch structure for an Amplify App.
534 */
535 branch: Branch;
536 }
537 export interface DeleteDomainAssociationRequest {
538 /**
539 * Unique Id for an Amplify App.
540 */
541 appId: AppId;
542 /**
543 * Name of the domain.
544 */
545 domainName: DomainName;
546 }
547 export interface DeleteDomainAssociationResult {
548 domainAssociation: DomainAssociation;
549 }
550 export interface DeleteJobRequest {
551 /**
552 * Unique Id for an Amplify App.
553 */
554 appId: AppId;
555 /**
556 * Name for the branch, for the Job.
557 */
558 branchName: BranchName;
559 /**
560 * Unique Id for the Job.
561 */
562 jobId: JobId;
563 }
564 export interface DeleteJobResult {
565 jobSummary: JobSummary;
566 }
567 export type Description = string;
568 export type DisplayName = string;
569 export interface DomainAssociation {
570 /**
571 * ARN for the Domain Association.
572 */
573 domainAssociationArn: DomainAssociationArn;
574 /**
575 * Name of the domain.
576 */
577 domainName: DomainName;
578 /**
579 * Enables automated creation of Subdomains for branches.
580 */
581 enableAutoSubDomain: EnableAutoSubDomain;
582 /**
583 * Status fo the Domain Association.
584 */
585 domainStatus: DomainStatus;
586 /**
587 * Reason for the current status of the Domain Association.
588 */
589 statusReason: StatusReason;
590 /**
591 * DNS Record for certificate verification.
592 */
593 certificateVerificationDNSRecord: CertificateVerificationDNSRecord;
594 /**
595 * Subdomains for the Domain Association.
596 */
597 subDomains: SubDomains;
598 }
599 export type DomainAssociationArn = string;
600 export type DomainAssociations = DomainAssociation[];
601 export type DomainName = string;
602 export type DomainPrefix = string;
603 export type DomainStatus = "PENDING_VERIFICATION"|"IN_PROGRESS"|"AVAILABLE"|"PENDING_DEPLOYMENT"|"FAILED"|string;
604 export type EnableAutoBuild = boolean;
605 export type EnableAutoSubDomain = boolean;
606 export type EnableBasicAuth = boolean;
607 export type EnableBranchAutoBuild = boolean;
608 export type EnableNotification = boolean;
609 export type EndTime = Date;
610 export type EnvKey = string;
611 export type EnvValue = string;
612 export type EnvironmentVariables = {[key: string]: EnvValue};
613 export type Framework = string;
614 export interface GetAppRequest {
615 /**
616 * Unique Id for an Amplify App.
617 */
618 appId: AppId;
619 }
620 export interface GetAppResult {
621 app: App;
622 }
623 export interface GetBranchRequest {
624 /**
625 * Unique Id for an Amplify App.
626 */
627 appId: AppId;
628 /**
629 * Name for the branch.
630 */
631 branchName: BranchName;
632 }
633 export interface GetBranchResult {
634 branch: Branch;
635 }
636 export interface GetDomainAssociationRequest {
637 /**
638 * Unique Id for an Amplify App.
639 */
640 appId: AppId;
641 /**
642 * Name of the domain.
643 */
644 domainName: DomainName;
645 }
646 export interface GetDomainAssociationResult {
647 /**
648 * Domain Association structure.
649 */
650 domainAssociation: DomainAssociation;
651 }
652 export interface GetJobRequest {
653 /**
654 * Unique Id for an Amplify App.
655 */
656 appId: AppId;
657 /**
658 * Name for the branch, for the Job.
659 */
660 branchName: BranchName;
661 /**
662 * Unique Id for the Job.
663 */
664 jobId: JobId;
665 }
666 export interface GetJobResult {
667 job: Job;
668 }
669 export interface Job {
670 /**
671 * Summary for an execution job for an Amplify App.
672 */
673 summary: JobSummary;
674 /**
675 * Execution steps for an execution job, for an Amplify App.
676 */
677 steps: Steps;
678 }
679 export type JobArn = string;
680 export type JobId = string;
681 export type JobReason = string;
682 export type JobStatus = "PENDING"|"PROVISIONING"|"RUNNING"|"FAILED"|"SUCCEED"|"CANCELLING"|"CANCELLED"|string;
683 export type JobSummaries = JobSummary[];
684 export interface JobSummary {
685 /**
686 * Arn for the Job.
687 */
688 jobArn: JobArn;
689 /**
690 * Unique Id for the Job.
691 */
692 jobId: JobId;
693 /**
694 * Commit Id from 3rd party repository provider for the Job.
695 */
696 commitId: CommitId;
697 /**
698 * Commit message from 3rd party repository provider for the Job.
699 */
700 commitMessage: CommitMessage;
701 /**
702 * Commit date / time for the Job.
703 */
704 commitTime: CommitTime;
705 /**
706 * Start date / time for the Job.
707 */
708 startTime: StartTime;
709 /**
710 * Status for the Job.
711 */
712 status: JobStatus;
713 /**
714 * End date / time for the Job.
715 */
716 endTime?: EndTime;
717 /**
718 * Type for the Job.
719 */
720 jobType: JobType;
721 }
722 export type JobType = "RELEASE"|"RETRY"|"WEB_HOOK"|string;
723 export type LastDeployTime = Date;
724 export interface ListAppsRequest {
725 /**
726 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
727 */
728 nextToken?: NextToken;
729 /**
730 * Maximum number of records to list in a single response.
731 */
732 maxResults?: MaxResults;
733 }
734 export interface ListAppsResult {
735 /**
736 * List of Amplify Apps.
737 */
738 apps: Apps;
739 /**
740 * Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.
741 */
742 nextToken?: NextToken;
743 }
744 export interface ListBranchesRequest {
745 /**
746 * Unique Id for an Amplify App.
747 */
748 appId: AppId;
749 /**
750 * Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.
751 */
752 nextToken?: NextToken;
753 /**
754 * Maximum number of records to list in a single response.
755 */
756 maxResults?: MaxResults;
757 }
758 export interface ListBranchesResult {
759 /**
760 * List of branches for an Amplify App.
761 */
762 branches: Branches;
763 /**
764 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
765 */
766 nextToken?: NextToken;
767 }
768 export interface ListDomainAssociationsRequest {
769 /**
770 * Unique Id for an Amplify App.
771 */
772 appId: AppId;
773 /**
774 * Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.
775 */
776 nextToken?: NextToken;
777 /**
778 * Maximum number of records to list in a single response.
779 */
780 maxResults?: MaxResults;
781 }
782 export interface ListDomainAssociationsResult {
783 /**
784 * List of Domain Associations.
785 */
786 domainAssociations: DomainAssociations;
787 /**
788 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
789 */
790 nextToken?: NextToken;
791 }
792 export interface ListJobsRequest {
793 /**
794 * Unique Id for an Amplify App.
795 */
796 appId: AppId;
797 /**
798 * Name for a branch.
799 */
800 branchName: BranchName;
801 /**
802 * Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.
803 */
804 nextToken?: NextToken;
805 /**
806 * Maximum number of records to list in a single response.
807 */
808 maxResults?: MaxResults;
809 }
810 export interface ListJobsResult {
811 /**
812 * Result structure for list job result request.
813 */
814 jobSummaries: JobSummaries;
815 /**
816 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
817 */
818 nextToken?: NextToken;
819 }
820 export type LogUrl = string;
821 export type MaxResults = number;
822 export type Name = string;
823 export type NextToken = string;
824 export type OauthToken = string;
825 export type Platform = "IOS"|"ANDROID"|"WEB"|"REACT_NATIVE"|string;
826 export interface ProductionBranch {
827 /**
828 * Last Deploy Time of Production Branch.
829 */
830 lastDeployTime?: LastDeployTime;
831 /**
832 * Status of Production Branch.
833 */
834 status?: Status;
835 /**
836 * Thumbnail Url for Production Branch.
837 */
838 thumbnailUrl?: ThumbnailUrl;
839 /**
840 * Branch Name for Production Branch.
841 */
842 branchName?: BranchName;
843 }
844 export type Repository = string;
845 export type Screenshots = {[key: string]: ThumbnailUrl};
846 export type ServiceRoleArn = string;
847 export type Source = string;
848 export type Stage = "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|string;
849 export interface StartJobRequest {
850 /**
851 * Unique Id for an Amplify App.
852 */
853 appId: AppId;
854 /**
855 * Name for the branch, for the Job.
856 */
857 branchName: BranchName;
858 /**
859 * Unique Id for the Job.
860 */
861 jobId?: JobId;
862 /**
863 * Type for the Job.
864 */
865 jobType: JobType;
866 /**
867 * Reason for the Job.
868 */
869 jobReason?: JobReason;
870 /**
871 * Commit Id from 3rd party repository provider for the Job.
872 */
873 commitId?: CommitId;
874 /**
875 * Commit message from 3rd party repository provider for the Job.
876 */
877 commitMessage?: CommitMessage;
878 /**
879 * Commit date / time for the Job.
880 */
881 commitTime?: CommitTime;
882 }
883 export interface StartJobResult {
884 /**
885 * Summary for the Job.
886 */
887 jobSummary: JobSummary;
888 }
889 export type StartTime = Date;
890 export type Status = string;
891 export type StatusReason = string;
892 export interface Step {
893 /**
894 * Name of the execution step.
895 */
896 stepName: StepName;
897 /**
898 * Start date/ time of the execution step.
899 */
900 startTime: StartTime;
901 /**
902 * Status of the execution step.
903 */
904 status: JobStatus;
905 /**
906 * End date/ time of the execution step.
907 */
908 endTime: EndTime;
909 /**
910 * Url to the logs for the execution step.
911 */
912 logUrl?: LogUrl;
913 /**
914 * Url to teh artifact for the execution step.
915 */
916 artifactsUrl?: ArtifactsUrl;
917 /**
918 * List of screenshot Urls for the execution step, if relevant.
919 */
920 screenshots?: Screenshots;
921 }
922 export type StepName = string;
923 export type Steps = Step[];
924 export interface StopJobRequest {
925 /**
926 * Unique Id for an Amplify App.
927 */
928 appId: AppId;
929 /**
930 * Name for the branch, for the Job.
931 */
932 branchName: BranchName;
933 /**
934 * Unique Id for the Job.
935 */
936 jobId: JobId;
937 }
938 export interface StopJobResult {
939 /**
940 * Summary for the Job.
941 */
942 jobSummary: JobSummary;
943 }
944 export interface SubDomain {
945 /**
946 * Setting structure for the Subdomain.
947 */
948 subDomainSetting: SubDomainSetting;
949 /**
950 * Verified status of the Subdomain
951 */
952 verified: Verified;
953 /**
954 * DNS record for the Subdomain.
955 */
956 dnsRecord: DNSRecord;
957 }
958 export interface SubDomainSetting {
959 /**
960 * Prefix setting for the Subdomain.
961 */
962 prefix: DomainPrefix;
963 /**
964 * Branch name setting for the Subdomain.
965 */
966 branchName: BranchName;
967 }
968 export type SubDomainSettings = SubDomainSetting[];
969 export type SubDomains = SubDomain[];
970 export type TTL = string;
971 export type TagKey = string;
972 export type TagValue = string;
973 export type Tags = {[key: string]: TagValue};
974 export type Target = string;
975 export type ThumbnailName = string;
976 export type ThumbnailUrl = string;
977 export type TotalNumberOfJobs = string;
978 export interface UpdateAppRequest {
979 /**
980 * Unique Id for an Amplify App.
981 */
982 appId: AppId;
983 /**
984 * Name for an Amplify App.
985 */
986 name?: Name;
987 /**
988 * Description for an Amplify App.
989 */
990 description?: Description;
991 /**
992 * Platform for an Amplify App.
993 */
994 platform?: Platform;
995 /**
996 * IAM service role for an Amplify App.
997 */
998 iamServiceRoleArn?: ServiceRoleArn;
999 /**
1000 * Environment Variables for an Amplify App.
1001 */
1002 environmentVariables?: EnvironmentVariables;
1003 /**
1004 * Enables branch auto-building for an Amplify App.
1005 */
1006 enableBranchAutoBuild?: EnableAutoBuild;
1007 /**
1008 * Enables Basic Authorization for an Amplify App.
1009 */
1010 enableBasicAuth?: EnableBasicAuth;
1011 /**
1012 * Basic Authorization credentials for an Amplify App.
1013 */
1014 basicAuthCredentials?: BasicAuthCredentials;
1015 /**
1016 * Custom redirect / rewrite rules for an Amplify App.
1017 */
1018 customRules?: CustomRules;
1019 /**
1020 * BuildSpec for an Amplify App.
1021 */
1022 buildSpec?: BuildSpec;
1023 }
1024 export interface UpdateAppResult {
1025 /**
1026 * App structure for the updated App.
1027 */
1028 app: App;
1029 }
1030 export interface UpdateBranchRequest {
1031 /**
1032 * Unique Id for an Amplify App.
1033 */
1034 appId: AppId;
1035 /**
1036 * Name for the branch.
1037 */
1038 branchName: BranchName;
1039 /**
1040 * Description for the branch.
1041 */
1042 description?: Description;
1043 /**
1044 * Framework for the branch.
1045 */
1046 framework?: Framework;
1047 /**
1048 * Stage for the branch.
1049 */
1050 stage?: Stage;
1051 /**
1052 * Enables notifications for the branch.
1053 */
1054 enableNotification?: EnableNotification;
1055 /**
1056 * Enables auto building for the branch.
1057 */
1058 enableAutoBuild?: EnableAutoBuild;
1059 /**
1060 * Environment Variables for the branch.
1061 */
1062 environmentVariables?: EnvironmentVariables;
1063 /**
1064 * Basic Authorization credentials for the branch.
1065 */
1066 basicAuthCredentials?: BasicAuthCredentials;
1067 /**
1068 * Enables Basic Auth for the branch.
1069 */
1070 enableBasicAuth?: EnableBasicAuth;
1071 /**
1072 * BuildSpec for the branch.
1073 */
1074 buildSpec?: BuildSpec;
1075 /**
1076 * The content TTL for the website in seconds.
1077 */
1078 ttl?: TTL;
1079 }
1080 export interface UpdateBranchResult {
1081 /**
1082 * Branch structure for an Amplify App.
1083 */
1084 branch: Branch;
1085 }
1086 export interface UpdateDomainAssociationRequest {
1087 /**
1088 * Unique Id for an Amplify App.
1089 */
1090 appId: AppId;
1091 /**
1092 * Name of the domain.
1093 */
1094 domainName: DomainName;
1095 /**
1096 * Enables automated creation of Subdomains for branches.
1097 */
1098 enableAutoSubDomain?: EnableAutoSubDomain;
1099 /**
1100 * Setting structure for the Subdomain.
1101 */
1102 subDomainSettings: SubDomainSettings;
1103 }
1104 export interface UpdateDomainAssociationResult {
1105 /**
1106 * Domain Association structure.
1107 */
1108 domainAssociation: DomainAssociation;
1109 }
1110 export type UpdateTime = Date;
1111 export type Verified = boolean;
1112 /**
1113 * 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.
1114 */
1115 export type apiVersion = "2017-07-25"|"latest"|string;
1116 export interface ClientApiVersions {
1117 /**
1118 * 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.
1119 */
1120 apiVersion?: apiVersion;
1121 }
1122 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1123 /**
1124 * Contains interfaces for use with the Amplify client.
1125 */
1126 export import Types = Amplify;
1127}
1128export = Amplify;