UNPKG

53.7 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 deployment for manual deploy apps. (Apps are not connected to repository)
32 */
33 createDeployment(params: Amplify.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDeploymentResult) => void): Request<Amplify.Types.CreateDeploymentResult, AWSError>;
34 /**
35 * Create a deployment for manual deploy apps. (Apps are not connected to repository)
36 */
37 createDeployment(callback?: (err: AWSError, data: Amplify.Types.CreateDeploymentResult) => void): Request<Amplify.Types.CreateDeploymentResult, AWSError>;
38 /**
39 * Create a new DomainAssociation on an App
40 */
41 createDomainAssociation(params: Amplify.Types.CreateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>;
42 /**
43 * Create a new DomainAssociation on an App
44 */
45 createDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>;
46 /**
47 * Create a new webhook on an App.
48 */
49 createWebhook(params: Amplify.Types.CreateWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.CreateWebhookResult) => void): Request<Amplify.Types.CreateWebhookResult, AWSError>;
50 /**
51 * Create a new webhook on an App.
52 */
53 createWebhook(callback?: (err: AWSError, data: Amplify.Types.CreateWebhookResult) => void): Request<Amplify.Types.CreateWebhookResult, AWSError>;
54 /**
55 * Delete an existing Amplify App by appId.
56 */
57 deleteApp(params: Amplify.Types.DeleteAppRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>;
58 /**
59 * Delete an existing Amplify App by appId.
60 */
61 deleteApp(callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>;
62 /**
63 * Deletes a branch for an Amplify App.
64 */
65 deleteBranch(params: Amplify.Types.DeleteBranchRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>;
66 /**
67 * Deletes a branch for an Amplify App.
68 */
69 deleteBranch(callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>;
70 /**
71 * Deletes a DomainAssociation.
72 */
73 deleteDomainAssociation(params: Amplify.Types.DeleteDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>;
74 /**
75 * Deletes a DomainAssociation.
76 */
77 deleteDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>;
78 /**
79 * Delete a job, for an Amplify branch, part of Amplify App.
80 */
81 deleteJob(params: Amplify.Types.DeleteJobRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>;
82 /**
83 * Delete a job, for an Amplify branch, part of Amplify App.
84 */
85 deleteJob(callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>;
86 /**
87 * Deletes a webhook.
88 */
89 deleteWebhook(params: Amplify.Types.DeleteWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteWebhookResult) => void): Request<Amplify.Types.DeleteWebhookResult, AWSError>;
90 /**
91 * Deletes a webhook.
92 */
93 deleteWebhook(callback?: (err: AWSError, data: Amplify.Types.DeleteWebhookResult) => void): Request<Amplify.Types.DeleteWebhookResult, AWSError>;
94 /**
95 * Retrieve website access logs for a specific time range via a pre-signed URL. Optionally, deliver the logs to a given S3 bucket.
96 */
97 generateAccessLogs(params: Amplify.Types.GenerateAccessLogsRequest, callback?: (err: AWSError, data: Amplify.Types.GenerateAccessLogsResult) => void): Request<Amplify.Types.GenerateAccessLogsResult, AWSError>;
98 /**
99 * Retrieve website access logs for a specific time range via a pre-signed URL. Optionally, deliver the logs to a given S3 bucket.
100 */
101 generateAccessLogs(callback?: (err: AWSError, data: Amplify.Types.GenerateAccessLogsResult) => void): Request<Amplify.Types.GenerateAccessLogsResult, AWSError>;
102 /**
103 * Retrieves an existing Amplify App by appId.
104 */
105 getApp(params: Amplify.Types.GetAppRequest, callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>;
106 /**
107 * Retrieves an existing Amplify App by appId.
108 */
109 getApp(callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>;
110 /**
111 * Retrieves artifact info that corresponds to a artifactId.
112 */
113 getArtifactUrl(params: Amplify.Types.GetArtifactUrlRequest, callback?: (err: AWSError, data: Amplify.Types.GetArtifactUrlResult) => void): Request<Amplify.Types.GetArtifactUrlResult, AWSError>;
114 /**
115 * Retrieves artifact info that corresponds to a artifactId.
116 */
117 getArtifactUrl(callback?: (err: AWSError, data: Amplify.Types.GetArtifactUrlResult) => void): Request<Amplify.Types.GetArtifactUrlResult, AWSError>;
118 /**
119 * Retrieves a branch for an Amplify App.
120 */
121 getBranch(params: Amplify.Types.GetBranchRequest, callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>;
122 /**
123 * Retrieves a branch for an Amplify App.
124 */
125 getBranch(callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>;
126 /**
127 * Retrieves domain info that corresponds to an appId and domainName.
128 */
129 getDomainAssociation(params: Amplify.Types.GetDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>;
130 /**
131 * Retrieves domain info that corresponds to an appId and domainName.
132 */
133 getDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>;
134 /**
135 * Get a job for a branch, part of an Amplify App.
136 */
137 getJob(params: Amplify.Types.GetJobRequest, callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>;
138 /**
139 * Get a job for a branch, part of an Amplify App.
140 */
141 getJob(callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>;
142 /**
143 * Retrieves webhook info that corresponds to a webhookId.
144 */
145 getWebhook(params: Amplify.Types.GetWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.GetWebhookResult) => void): Request<Amplify.Types.GetWebhookResult, AWSError>;
146 /**
147 * Retrieves webhook info that corresponds to a webhookId.
148 */
149 getWebhook(callback?: (err: AWSError, data: Amplify.Types.GetWebhookResult) => void): Request<Amplify.Types.GetWebhookResult, AWSError>;
150 /**
151 * Lists existing Amplify Apps.
152 */
153 listApps(params: Amplify.Types.ListAppsRequest, callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>;
154 /**
155 * Lists existing Amplify Apps.
156 */
157 listApps(callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>;
158 /**
159 * List artifacts with an app, a branch, a job and an artifact type.
160 */
161 listArtifacts(params: Amplify.Types.ListArtifactsRequest, callback?: (err: AWSError, data: Amplify.Types.ListArtifactsResult) => void): Request<Amplify.Types.ListArtifactsResult, AWSError>;
162 /**
163 * List artifacts with an app, a branch, a job and an artifact type.
164 */
165 listArtifacts(callback?: (err: AWSError, data: Amplify.Types.ListArtifactsResult) => void): Request<Amplify.Types.ListArtifactsResult, AWSError>;
166 /**
167 * Lists branches for an Amplify App.
168 */
169 listBranches(params: Amplify.Types.ListBranchesRequest, callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>;
170 /**
171 * Lists branches for an Amplify App.
172 */
173 listBranches(callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>;
174 /**
175 * List domains with an app
176 */
177 listDomainAssociations(params: Amplify.Types.ListDomainAssociationsRequest, callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>;
178 /**
179 * List domains with an app
180 */
181 listDomainAssociations(callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>;
182 /**
183 * List Jobs for a branch, part of an Amplify App.
184 */
185 listJobs(params: Amplify.Types.ListJobsRequest, callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>;
186 /**
187 * List Jobs for a branch, part of an Amplify App.
188 */
189 listJobs(callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>;
190 /**
191 * List tags for resource.
192 */
193 listTagsForResource(params: Amplify.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Amplify.Types.ListTagsForResourceResponse) => void): Request<Amplify.Types.ListTagsForResourceResponse, AWSError>;
194 /**
195 * List tags for resource.
196 */
197 listTagsForResource(callback?: (err: AWSError, data: Amplify.Types.ListTagsForResourceResponse) => void): Request<Amplify.Types.ListTagsForResourceResponse, AWSError>;
198 /**
199 * List webhooks with an app.
200 */
201 listWebhooks(params: Amplify.Types.ListWebhooksRequest, callback?: (err: AWSError, data: Amplify.Types.ListWebhooksResult) => void): Request<Amplify.Types.ListWebhooksResult, AWSError>;
202 /**
203 * List webhooks with an app.
204 */
205 listWebhooks(callback?: (err: AWSError, data: Amplify.Types.ListWebhooksResult) => void): Request<Amplify.Types.ListWebhooksResult, AWSError>;
206 /**
207 * Start a deployment for manual deploy apps. (Apps are not connected to repository)
208 */
209 startDeployment(params: Amplify.Types.StartDeploymentRequest, callback?: (err: AWSError, data: Amplify.Types.StartDeploymentResult) => void): Request<Amplify.Types.StartDeploymentResult, AWSError>;
210 /**
211 * Start a deployment for manual deploy apps. (Apps are not connected to repository)
212 */
213 startDeployment(callback?: (err: AWSError, data: Amplify.Types.StartDeploymentResult) => void): Request<Amplify.Types.StartDeploymentResult, AWSError>;
214 /**
215 * Starts a new job for a branch, part of an Amplify App.
216 */
217 startJob(params: Amplify.Types.StartJobRequest, callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>;
218 /**
219 * Starts a new job for a branch, part of an Amplify App.
220 */
221 startJob(callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>;
222 /**
223 * Stop a job that is in progress, for an Amplify branch, part of Amplify App.
224 */
225 stopJob(params: Amplify.Types.StopJobRequest, callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>;
226 /**
227 * Stop a job that is in progress, for an Amplify branch, part of Amplify App.
228 */
229 stopJob(callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>;
230 /**
231 * Tag resource with tag key and value.
232 */
233 tagResource(params: Amplify.Types.TagResourceRequest, callback?: (err: AWSError, data: Amplify.Types.TagResourceResponse) => void): Request<Amplify.Types.TagResourceResponse, AWSError>;
234 /**
235 * Tag resource with tag key and value.
236 */
237 tagResource(callback?: (err: AWSError, data: Amplify.Types.TagResourceResponse) => void): Request<Amplify.Types.TagResourceResponse, AWSError>;
238 /**
239 * Untag resource with resourceArn.
240 */
241 untagResource(params: Amplify.Types.UntagResourceRequest, callback?: (err: AWSError, data: Amplify.Types.UntagResourceResponse) => void): Request<Amplify.Types.UntagResourceResponse, AWSError>;
242 /**
243 * Untag resource with resourceArn.
244 */
245 untagResource(callback?: (err: AWSError, data: Amplify.Types.UntagResourceResponse) => void): Request<Amplify.Types.UntagResourceResponse, AWSError>;
246 /**
247 * Updates an existing Amplify App.
248 */
249 updateApp(params: Amplify.Types.UpdateAppRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>;
250 /**
251 * Updates an existing Amplify App.
252 */
253 updateApp(callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>;
254 /**
255 * Updates a branch for an Amplify App.
256 */
257 updateBranch(params: Amplify.Types.UpdateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>;
258 /**
259 * Updates a branch for an Amplify App.
260 */
261 updateBranch(callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>;
262 /**
263 * Create a new DomainAssociation on an App
264 */
265 updateDomainAssociation(params: Amplify.Types.UpdateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>;
266 /**
267 * Create a new DomainAssociation on an App
268 */
269 updateDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>;
270 /**
271 * Update a webhook.
272 */
273 updateWebhook(params: Amplify.Types.UpdateWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateWebhookResult) => void): Request<Amplify.Types.UpdateWebhookResult, AWSError>;
274 /**
275 * Update a webhook.
276 */
277 updateWebhook(callback?: (err: AWSError, data: Amplify.Types.UpdateWebhookResult) => void): Request<Amplify.Types.UpdateWebhookResult, AWSError>;
278}
279declare namespace Amplify {
280 export type AccessToken = string;
281 export type ActiveJobId = string;
282 export interface App {
283 /**
284 * Unique Id for the Amplify App.
285 */
286 appId: AppId;
287 /**
288 * ARN for the Amplify App.
289 */
290 appArn: AppArn;
291 /**
292 * Name for the Amplify App.
293 */
294 name: Name;
295 /**
296 * Tag for Amplify App.
297 */
298 tags?: TagMap;
299 /**
300 * Description for the Amplify App.
301 */
302 description: Description;
303 /**
304 * Repository for the Amplify App.
305 */
306 repository: Repository;
307 /**
308 * Platform for the Amplify App.
309 */
310 platform: Platform;
311 /**
312 * Create date / time for the Amplify App.
313 */
314 createTime: CreateTime;
315 /**
316 * Update date / time for the Amplify App.
317 */
318 updateTime: UpdateTime;
319 /**
320 * IAM service role ARN for the Amplify App.
321 */
322 iamServiceRoleArn?: ServiceRoleArn;
323 /**
324 * Environment Variables for the Amplify App.
325 */
326 environmentVariables: EnvironmentVariables;
327 /**
328 * Default domain for the Amplify App.
329 */
330 defaultDomain: DefaultDomain;
331 /**
332 * Enables auto-building of branches for the Amplify App.
333 */
334 enableBranchAutoBuild: EnableBranchAutoBuild;
335 /**
336 * Enables Basic Authorization for branches for the Amplify App.
337 */
338 enableBasicAuth: EnableBasicAuth;
339 /**
340 * Basic Authorization credentials for branches for the Amplify App.
341 */
342 basicAuthCredentials?: BasicAuthCredentials;
343 /**
344 * Custom redirect / rewrite rules for the Amplify App.
345 */
346 customRules?: CustomRules;
347 /**
348 * Structure with Production Branch information.
349 */
350 productionBranch?: ProductionBranch;
351 /**
352 * BuildSpec content for Amplify App.
353 */
354 buildSpec?: BuildSpec;
355 /**
356 * Enables automated branch creation for the Amplify App.
357 */
358 enableAutoBranchCreation?: EnableAutoBranchCreation;
359 /**
360 * Automated branch creation glob patterns for the Amplify App.
361 */
362 autoBranchCreationPatterns?: AutoBranchCreationPatterns;
363 /**
364 * Automated branch creation config for the Amplify App.
365 */
366 autoBranchCreationConfig?: AutoBranchCreationConfig;
367 }
368 export type AppArn = string;
369 export type AppId = string;
370 export type Apps = App[];
371 export interface Artifact {
372 /**
373 * File name for the artifact.
374 */
375 artifactFileName: ArtifactFileName;
376 /**
377 * Unique Id for a artifact.
378 */
379 artifactId: ArtifactId;
380 }
381 export type ArtifactFileName = string;
382 export type ArtifactId = string;
383 export type ArtifactType = "TEST"|string;
384 export type ArtifactUrl = string;
385 export type Artifacts = Artifact[];
386 export type ArtifactsUrl = string;
387 export type AssociatedResource = string;
388 export type AssociatedResources = AssociatedResource[];
389 export interface AutoBranchCreationConfig {
390 /**
391 * Stage for the auto created branch.
392 */
393 stage?: Stage;
394 /**
395 * Framework for the auto created branch.
396 */
397 framework?: Framework;
398 /**
399 * Enables auto building for the auto created branch.
400 */
401 enableAutoBuild?: EnableAutoBuild;
402 /**
403 * Environment Variables for the auto created branch.
404 */
405 environmentVariables?: EnvironmentVariables;
406 /**
407 * Basic Authorization credentials for the auto created branch.
408 */
409 basicAuthCredentials?: BasicAuthCredentials;
410 /**
411 * Enables Basic Auth for the auto created branch.
412 */
413 enableBasicAuth?: EnableBasicAuth;
414 /**
415 * BuildSpec for the auto created branch.
416 */
417 buildSpec?: BuildSpec;
418 /**
419 * Enables Pull Request Preview for auto created branch.
420 */
421 enablePullRequestPreview?: EnablePullRequestPreview;
422 }
423 export type AutoBranchCreationPattern = string;
424 export type AutoBranchCreationPatterns = AutoBranchCreationPattern[];
425 export type BasicAuthCredentials = string;
426 export interface Branch {
427 /**
428 * ARN for a branch, part of an Amplify App.
429 */
430 branchArn: BranchArn;
431 /**
432 * Name for a branch, part of an Amplify App.
433 */
434 branchName: BranchName;
435 /**
436 * Description for a branch, part of an Amplify App.
437 */
438 description: Description;
439 /**
440 * Tag for branch for Amplify App.
441 */
442 tags?: TagMap;
443 /**
444 * Stage for a branch, part of an Amplify App.
445 */
446 stage: Stage;
447 /**
448 * Display name for a branch, will use as the default domain prefix.
449 */
450 displayName: DisplayName;
451 /**
452 * Enables notifications for a branch, part of an Amplify App.
453 */
454 enableNotification: EnableNotification;
455 /**
456 * Creation date and time for a branch, part of an Amplify App.
457 */
458 createTime: CreateTime;
459 /**
460 * Last updated date and time for a branch, part of an Amplify App.
461 */
462 updateTime: UpdateTime;
463 /**
464 * Environment Variables specific to a branch, part of an Amplify App.
465 */
466 environmentVariables: EnvironmentVariables;
467 /**
468 * Enables auto-building on push for a branch, part of an Amplify App.
469 */
470 enableAutoBuild: EnableAutoBuild;
471 /**
472 * Custom domains for a branch, part of an Amplify App.
473 */
474 customDomains: CustomDomains;
475 /**
476 * Framework for a branch, part of an Amplify App.
477 */
478 framework: Framework;
479 /**
480 * Id of the active job for a branch, part of an Amplify App.
481 */
482 activeJobId: ActiveJobId;
483 /**
484 * Total number of Jobs part of an Amplify App.
485 */
486 totalNumberOfJobs: TotalNumberOfJobs;
487 /**
488 * Enables Basic Authorization for a branch, part of an Amplify App.
489 */
490 enableBasicAuth: EnableBasicAuth;
491 /**
492 * Thumbnail URL for the branch.
493 */
494 thumbnailUrl?: ThumbnailUrl;
495 /**
496 * Basic Authorization credentials for a branch, part of an Amplify App.
497 */
498 basicAuthCredentials?: BasicAuthCredentials;
499 /**
500 * BuildSpec content for branch for Amplify App.
501 */
502 buildSpec?: BuildSpec;
503 /**
504 * The content TTL for the website in seconds.
505 */
506 ttl: TTL;
507 /**
508 * List of custom resources that are linked to this branch.
509 */
510 associatedResources?: AssociatedResources;
511 /**
512 * Enables Pull Request Preview for this branch.
513 */
514 enablePullRequestPreview: EnablePullRequestPreview;
515 /**
516 * The destination branch if the branch is a pull request branch.
517 */
518 destinationBranch?: BranchName;
519 /**
520 * The source branch if the branch is a pull request branch.
521 */
522 sourceBranch?: BranchName;
523 }
524 export type BranchArn = string;
525 export type BranchName = string;
526 export type Branches = Branch[];
527 export type BuildSpec = string;
528 export type CertificateVerificationDNSRecord = string;
529 export type CommitId = string;
530 export type CommitMessage = string;
531 export type CommitTime = Date;
532 export type Condition = string;
533 export type Context = string;
534 export interface CreateAppRequest {
535 /**
536 * Name for the Amplify App
537 */
538 name: Name;
539 /**
540 * Description for an Amplify App
541 */
542 description?: Description;
543 /**
544 * Repository for an Amplify App
545 */
546 repository?: Repository;
547 /**
548 * Platform / framework for an Amplify App
549 */
550 platform?: Platform;
551 /**
552 * AWS IAM service role for an Amplify App
553 */
554 iamServiceRoleArn?: ServiceRoleArn;
555 /**
556 * 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.
557 */
558 oauthToken?: OauthToken;
559 /**
560 * Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.
561 */
562 accessToken?: AccessToken;
563 /**
564 * Environment variables map for an Amplify App.
565 */
566 environmentVariables?: EnvironmentVariables;
567 /**
568 * Enable the auto building of branches for an Amplify App.
569 */
570 enableBranchAutoBuild?: EnableBranchAutoBuild;
571 /**
572 * Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
573 */
574 enableBasicAuth?: EnableBasicAuth;
575 /**
576 * Credentials for Basic Authorization for an Amplify App.
577 */
578 basicAuthCredentials?: BasicAuthCredentials;
579 /**
580 * Custom rewrite / redirect rules for an Amplify App.
581 */
582 customRules?: CustomRules;
583 /**
584 * Tag for an Amplify App
585 */
586 tags?: TagMap;
587 /**
588 * BuildSpec for an Amplify App
589 */
590 buildSpec?: BuildSpec;
591 /**
592 * Enables automated branch creation for the Amplify App.
593 */
594 enableAutoBranchCreation?: EnableAutoBranchCreation;
595 /**
596 * Automated branch creation glob patterns for the Amplify App.
597 */
598 autoBranchCreationPatterns?: AutoBranchCreationPatterns;
599 /**
600 * Automated branch creation config for the Amplify App.
601 */
602 autoBranchCreationConfig?: AutoBranchCreationConfig;
603 }
604 export interface CreateAppResult {
605 app: App;
606 }
607 export interface CreateBranchRequest {
608 /**
609 * Unique Id for an Amplify App.
610 */
611 appId: AppId;
612 /**
613 * Name for the branch.
614 */
615 branchName: BranchName;
616 /**
617 * Description for the branch.
618 */
619 description?: Description;
620 /**
621 * Stage for the branch.
622 */
623 stage?: Stage;
624 /**
625 * Framework for the branch.
626 */
627 framework?: Framework;
628 /**
629 * Enables notifications for the branch.
630 */
631 enableNotification?: EnableNotification;
632 /**
633 * Enables auto building for the branch.
634 */
635 enableAutoBuild?: EnableAutoBuild;
636 /**
637 * Environment Variables for the branch.
638 */
639 environmentVariables?: EnvironmentVariables;
640 /**
641 * Basic Authorization credentials for the branch.
642 */
643 basicAuthCredentials?: BasicAuthCredentials;
644 /**
645 * Enables Basic Auth for the branch.
646 */
647 enableBasicAuth?: EnableBasicAuth;
648 /**
649 * Tag for the branch.
650 */
651 tags?: TagMap;
652 /**
653 * BuildSpec for the branch.
654 */
655 buildSpec?: BuildSpec;
656 /**
657 * The content TTL for the website in seconds.
658 */
659 ttl?: TTL;
660 /**
661 * Display name for a branch, will use as the default domain prefix.
662 */
663 displayName?: DisplayName;
664 /**
665 * Enables Pull Request Preview for this branch.
666 */
667 enablePullRequestPreview?: EnablePullRequestPreview;
668 }
669 export interface CreateBranchResult {
670 /**
671 * Branch structure for an Amplify App.
672 */
673 branch: Branch;
674 }
675 export interface CreateDeploymentRequest {
676 /**
677 * Unique Id for an Amplify App.
678 */
679 appId: AppId;
680 /**
681 * Name for the branch, for the Job.
682 */
683 branchName: BranchName;
684 /**
685 * Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files.
686 */
687 fileMap?: FileMap;
688 }
689 export interface CreateDeploymentResult {
690 /**
691 * The jobId for this deployment, will supply to start deployment api.
692 */
693 jobId?: JobId;
694 /**
695 * When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url.
696 */
697 fileUploadUrls: FileUploadUrls;
698 /**
699 * When the fileMap argument is NOT provided. This zipUploadUrl will be returned.
700 */
701 zipUploadUrl: UploadUrl;
702 }
703 export interface CreateDomainAssociationRequest {
704 /**
705 * Unique Id for an Amplify App.
706 */
707 appId: AppId;
708 /**
709 * Domain name for the Domain Association.
710 */
711 domainName: DomainName;
712 /**
713 * Enables automated creation of Subdomains for branches.
714 */
715 enableAutoSubDomain?: EnableAutoSubDomain;
716 /**
717 * Setting structure for the Subdomain.
718 */
719 subDomainSettings: SubDomainSettings;
720 }
721 export interface CreateDomainAssociationResult {
722 /**
723 * Domain Association structure.
724 */
725 domainAssociation: DomainAssociation;
726 }
727 export type CreateTime = Date;
728 export interface CreateWebhookRequest {
729 /**
730 * Unique Id for an Amplify App.
731 */
732 appId: AppId;
733 /**
734 * Name for a branch, part of an Amplify App.
735 */
736 branchName: BranchName;
737 /**
738 * Description for a webhook.
739 */
740 description?: Description;
741 }
742 export interface CreateWebhookResult {
743 /**
744 * Webhook structure.
745 */
746 webhook: Webhook;
747 }
748 export type CustomDomain = string;
749 export type CustomDomains = CustomDomain[];
750 export interface CustomRule {
751 /**
752 * The source pattern for a URL rewrite or redirect rule.
753 */
754 source: Source;
755 /**
756 * The target pattern for a URL rewrite or redirect rule.
757 */
758 target: Target;
759 /**
760 * The status code for a URL rewrite or redirect rule.
761 */
762 status?: Status;
763 /**
764 * The condition for a URL rewrite or redirect rule, e.g. country code.
765 */
766 condition?: Condition;
767 }
768 export type CustomRules = CustomRule[];
769 export type DNSRecord = string;
770 export type DefaultDomain = string;
771 export interface DeleteAppRequest {
772 /**
773 * Unique Id for an Amplify App.
774 */
775 appId: AppId;
776 }
777 export interface DeleteAppResult {
778 app: App;
779 }
780 export interface DeleteBranchRequest {
781 /**
782 * Unique Id for an Amplify App.
783 */
784 appId: AppId;
785 /**
786 * Name for the branch.
787 */
788 branchName: BranchName;
789 }
790 export interface DeleteBranchResult {
791 /**
792 * Branch structure for an Amplify App.
793 */
794 branch: Branch;
795 }
796 export interface DeleteDomainAssociationRequest {
797 /**
798 * Unique Id for an Amplify App.
799 */
800 appId: AppId;
801 /**
802 * Name of the domain.
803 */
804 domainName: DomainName;
805 }
806 export interface DeleteDomainAssociationResult {
807 domainAssociation: DomainAssociation;
808 }
809 export interface DeleteJobRequest {
810 /**
811 * Unique Id for an Amplify App.
812 */
813 appId: AppId;
814 /**
815 * Name for the branch, for the Job.
816 */
817 branchName: BranchName;
818 /**
819 * Unique Id for the Job.
820 */
821 jobId: JobId;
822 }
823 export interface DeleteJobResult {
824 jobSummary: JobSummary;
825 }
826 export interface DeleteWebhookRequest {
827 /**
828 * Unique Id for a webhook.
829 */
830 webhookId: WebhookId;
831 }
832 export interface DeleteWebhookResult {
833 /**
834 * Webhook structure.
835 */
836 webhook: Webhook;
837 }
838 export type Description = string;
839 export type DisplayName = string;
840 export interface DomainAssociation {
841 /**
842 * ARN for the Domain Association.
843 */
844 domainAssociationArn: DomainAssociationArn;
845 /**
846 * Name of the domain.
847 */
848 domainName: DomainName;
849 /**
850 * Enables automated creation of Subdomains for branches.
851 */
852 enableAutoSubDomain: EnableAutoSubDomain;
853 /**
854 * Status fo the Domain Association.
855 */
856 domainStatus: DomainStatus;
857 /**
858 * Reason for the current status of the Domain Association.
859 */
860 statusReason: StatusReason;
861 /**
862 * DNS Record for certificate verification.
863 */
864 certificateVerificationDNSRecord?: CertificateVerificationDNSRecord;
865 /**
866 * Subdomains for the Domain Association.
867 */
868 subDomains: SubDomains;
869 }
870 export type DomainAssociationArn = string;
871 export type DomainAssociations = DomainAssociation[];
872 export type DomainName = string;
873 export type DomainPrefix = string;
874 export type DomainStatus = "PENDING_VERIFICATION"|"IN_PROGRESS"|"AVAILABLE"|"PENDING_DEPLOYMENT"|"FAILED"|"CREATING"|"REQUESTING_CERTIFICATE"|"UPDATING"|string;
875 export type EnableAutoBranchCreation = boolean;
876 export type EnableAutoBuild = boolean;
877 export type EnableAutoSubDomain = boolean;
878 export type EnableBasicAuth = boolean;
879 export type EnableBranchAutoBuild = boolean;
880 export type EnableNotification = boolean;
881 export type EnablePullRequestPreview = boolean;
882 export type EndTime = Date;
883 export type EnvKey = string;
884 export type EnvValue = string;
885 export type EnvironmentVariables = {[key: string]: EnvValue};
886 export type FileMap = {[key: string]: MD5Hash};
887 export type FileName = string;
888 export type FileUploadUrls = {[key: string]: UploadUrl};
889 export type Framework = string;
890 export interface GenerateAccessLogsRequest {
891 /**
892 * The time at which the logs should start, inclusive.
893 */
894 startTime?: StartTime;
895 /**
896 * The time at which the logs should end, inclusive.
897 */
898 endTime?: EndTime;
899 /**
900 * Name of the domain.
901 */
902 domainName: DomainName;
903 /**
904 * Unique Id for an Amplify App.
905 */
906 appId: AppId;
907 }
908 export interface GenerateAccessLogsResult {
909 /**
910 * Pre-signed URL for the requested access logs.
911 */
912 logUrl?: LogUrl;
913 }
914 export interface GetAppRequest {
915 /**
916 * Unique Id for an Amplify App.
917 */
918 appId: AppId;
919 }
920 export interface GetAppResult {
921 app: App;
922 }
923 export interface GetArtifactUrlRequest {
924 /**
925 * Unique Id for a artifact.
926 */
927 artifactId: ArtifactId;
928 }
929 export interface GetArtifactUrlResult {
930 /**
931 * Unique Id for a artifact.
932 */
933 artifactId: ArtifactId;
934 /**
935 * Presigned url for the artifact.
936 */
937 artifactUrl: ArtifactUrl;
938 }
939 export interface GetBranchRequest {
940 /**
941 * Unique Id for an Amplify App.
942 */
943 appId: AppId;
944 /**
945 * Name for the branch.
946 */
947 branchName: BranchName;
948 }
949 export interface GetBranchResult {
950 branch: Branch;
951 }
952 export interface GetDomainAssociationRequest {
953 /**
954 * Unique Id for an Amplify App.
955 */
956 appId: AppId;
957 /**
958 * Name of the domain.
959 */
960 domainName: DomainName;
961 }
962 export interface GetDomainAssociationResult {
963 /**
964 * Domain Association structure.
965 */
966 domainAssociation: DomainAssociation;
967 }
968 export interface GetJobRequest {
969 /**
970 * Unique Id for an Amplify App.
971 */
972 appId: AppId;
973 /**
974 * Name for the branch, for the Job.
975 */
976 branchName: BranchName;
977 /**
978 * Unique Id for the Job.
979 */
980 jobId: JobId;
981 }
982 export interface GetJobResult {
983 job: Job;
984 }
985 export interface GetWebhookRequest {
986 /**
987 * Unique Id for a webhook.
988 */
989 webhookId: WebhookId;
990 }
991 export interface GetWebhookResult {
992 /**
993 * Webhook structure.
994 */
995 webhook: Webhook;
996 }
997 export interface Job {
998 /**
999 * Summary for an execution job for an Amplify App.
1000 */
1001 summary: JobSummary;
1002 /**
1003 * Execution steps for an execution job, for an Amplify App.
1004 */
1005 steps: Steps;
1006 }
1007 export type JobArn = string;
1008 export type JobId = string;
1009 export type JobReason = string;
1010 export type JobStatus = "PENDING"|"PROVISIONING"|"RUNNING"|"FAILED"|"SUCCEED"|"CANCELLING"|"CANCELLED"|string;
1011 export type JobSummaries = JobSummary[];
1012 export interface JobSummary {
1013 /**
1014 * Arn for the Job.
1015 */
1016 jobArn: JobArn;
1017 /**
1018 * Unique Id for the Job.
1019 */
1020 jobId: JobId;
1021 /**
1022 * Commit Id from 3rd party repository provider for the Job.
1023 */
1024 commitId: CommitId;
1025 /**
1026 * Commit message from 3rd party repository provider for the Job.
1027 */
1028 commitMessage: CommitMessage;
1029 /**
1030 * Commit date / time for the Job.
1031 */
1032 commitTime: CommitTime;
1033 /**
1034 * Start date / time for the Job.
1035 */
1036 startTime: StartTime;
1037 /**
1038 * Status for the Job.
1039 */
1040 status: JobStatus;
1041 /**
1042 * End date / time for the Job.
1043 */
1044 endTime?: EndTime;
1045 /**
1046 * Type for the Job. \n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
1047 */
1048 jobType: JobType;
1049 }
1050 export type JobType = "RELEASE"|"RETRY"|"MANUAL"|"WEB_HOOK"|string;
1051 export type LastDeployTime = Date;
1052 export interface ListAppsRequest {
1053 /**
1054 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
1055 */
1056 nextToken?: NextToken;
1057 /**
1058 * Maximum number of records to list in a single response.
1059 */
1060 maxResults?: MaxResults;
1061 }
1062 export interface ListAppsResult {
1063 /**
1064 * List of Amplify Apps.
1065 */
1066 apps: Apps;
1067 /**
1068 * 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.
1069 */
1070 nextToken?: NextToken;
1071 }
1072 export interface ListArtifactsRequest {
1073 /**
1074 * Unique Id for an Amplify App.
1075 */
1076 appId: AppId;
1077 /**
1078 * Name for a branch, part of an Amplify App.
1079 */
1080 branchName: BranchName;
1081 /**
1082 * Unique Id for an Job.
1083 */
1084 jobId: JobId;
1085 /**
1086 * Type for an artifact.
1087 */
1088 artifactType?: ArtifactType;
1089 /**
1090 * Pagination token. Set to null to start listing artifacts from start. If non-null pagination token is returned in a result, then pass its value in here to list more artifacts.
1091 */
1092 nextToken?: NextToken;
1093 /**
1094 * Maximum number of records to list in a single response.
1095 */
1096 maxResults?: MaxResults;
1097 }
1098 export interface ListArtifactsResult {
1099 /**
1100 * List of artifacts.
1101 */
1102 artifacts: Artifacts;
1103 /**
1104 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
1105 */
1106 nextToken?: NextToken;
1107 }
1108 export interface ListBranchesRequest {
1109 /**
1110 * Unique Id for an Amplify App.
1111 */
1112 appId: AppId;
1113 /**
1114 * 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.
1115 */
1116 nextToken?: NextToken;
1117 /**
1118 * Maximum number of records to list in a single response.
1119 */
1120 maxResults?: MaxResults;
1121 }
1122 export interface ListBranchesResult {
1123 /**
1124 * List of branches for an Amplify App.
1125 */
1126 branches: Branches;
1127 /**
1128 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
1129 */
1130 nextToken?: NextToken;
1131 }
1132 export interface ListDomainAssociationsRequest {
1133 /**
1134 * Unique Id for an Amplify App.
1135 */
1136 appId: AppId;
1137 /**
1138 * 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.
1139 */
1140 nextToken?: NextToken;
1141 /**
1142 * Maximum number of records to list in a single response.
1143 */
1144 maxResults?: MaxResults;
1145 }
1146 export interface ListDomainAssociationsResult {
1147 /**
1148 * List of Domain Associations.
1149 */
1150 domainAssociations: DomainAssociations;
1151 /**
1152 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
1153 */
1154 nextToken?: NextToken;
1155 }
1156 export interface ListJobsRequest {
1157 /**
1158 * Unique Id for an Amplify App.
1159 */
1160 appId: AppId;
1161 /**
1162 * Name for a branch.
1163 */
1164 branchName: BranchName;
1165 /**
1166 * 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.
1167 */
1168 nextToken?: NextToken;
1169 /**
1170 * Maximum number of records to list in a single response.
1171 */
1172 maxResults?: MaxResults;
1173 }
1174 export interface ListJobsResult {
1175 /**
1176 * Result structure for list job result request.
1177 */
1178 jobSummaries: JobSummaries;
1179 /**
1180 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
1181 */
1182 nextToken?: NextToken;
1183 }
1184 export interface ListTagsForResourceRequest {
1185 /**
1186 * Resource arn used to list tags.
1187 */
1188 resourceArn: ResourceArn;
1189 }
1190 export interface ListTagsForResourceResponse {
1191 /**
1192 * Tags result for response.
1193 */
1194 tags?: TagMap;
1195 }
1196 export interface ListWebhooksRequest {
1197 /**
1198 * Unique Id for an Amplify App.
1199 */
1200 appId: AppId;
1201 /**
1202 * Pagination token. Set to null to start listing webhooks from start. If non-null pagination token is returned in a result, then pass its value in here to list more webhooks.
1203 */
1204 nextToken?: NextToken;
1205 /**
1206 * Maximum number of records to list in a single response.
1207 */
1208 maxResults?: MaxResults;
1209 }
1210 export interface ListWebhooksResult {
1211 /**
1212 * List of webhooks.
1213 */
1214 webhooks: Webhooks;
1215 /**
1216 * Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
1217 */
1218 nextToken?: NextToken;
1219 }
1220 export type LogUrl = string;
1221 export type MD5Hash = string;
1222 export type MaxResults = number;
1223 export type Name = string;
1224 export type NextToken = string;
1225 export type OauthToken = string;
1226 export type Platform = "WEB"|string;
1227 export interface ProductionBranch {
1228 /**
1229 * Last Deploy Time of Production Branch.
1230 */
1231 lastDeployTime?: LastDeployTime;
1232 /**
1233 * Status of Production Branch.
1234 */
1235 status?: Status;
1236 /**
1237 * Thumbnail URL for Production Branch.
1238 */
1239 thumbnailUrl?: ThumbnailUrl;
1240 /**
1241 * Branch Name for Production Branch.
1242 */
1243 branchName?: BranchName;
1244 }
1245 export type Repository = string;
1246 export type ResourceArn = string;
1247 export type Screenshots = {[key: string]: ThumbnailUrl};
1248 export type ServiceRoleArn = string;
1249 export type Source = string;
1250 export type SourceUrl = string;
1251 export type Stage = "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|"PULL_REQUEST"|string;
1252 export interface StartDeploymentRequest {
1253 /**
1254 * Unique Id for an Amplify App.
1255 */
1256 appId: AppId;
1257 /**
1258 * Name for the branch, for the Job.
1259 */
1260 branchName: BranchName;
1261 /**
1262 * The job id for this deployment, generated by create deployment request.
1263 */
1264 jobId?: JobId;
1265 /**
1266 * The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.
1267 */
1268 sourceUrl?: SourceUrl;
1269 }
1270 export interface StartDeploymentResult {
1271 /**
1272 * Summary for the Job.
1273 */
1274 jobSummary: JobSummary;
1275 }
1276 export interface StartJobRequest {
1277 /**
1278 * Unique Id for an Amplify App.
1279 */
1280 appId: AppId;
1281 /**
1282 * Name for the branch, for the Job.
1283 */
1284 branchName: BranchName;
1285 /**
1286 * Unique Id for an existing job. Required for "RETRY" JobType.
1287 */
1288 jobId?: JobId;
1289 /**
1290 * Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.
1291 */
1292 jobType: JobType;
1293 /**
1294 * Descriptive reason for starting this job.
1295 */
1296 jobReason?: JobReason;
1297 /**
1298 * Commit Id from 3rd party repository provider for the Job.
1299 */
1300 commitId?: CommitId;
1301 /**
1302 * Commit message from 3rd party repository provider for the Job.
1303 */
1304 commitMessage?: CommitMessage;
1305 /**
1306 * Commit date / time for the Job.
1307 */
1308 commitTime?: CommitTime;
1309 }
1310 export interface StartJobResult {
1311 /**
1312 * Summary for the Job.
1313 */
1314 jobSummary: JobSummary;
1315 }
1316 export type StartTime = Date;
1317 export type Status = string;
1318 export type StatusReason = string;
1319 export interface Step {
1320 /**
1321 * Name of the execution step.
1322 */
1323 stepName: StepName;
1324 /**
1325 * Start date/ time of the execution step.
1326 */
1327 startTime: StartTime;
1328 /**
1329 * Status of the execution step.
1330 */
1331 status: JobStatus;
1332 /**
1333 * End date/ time of the execution step.
1334 */
1335 endTime: EndTime;
1336 /**
1337 * URL to the logs for the execution step.
1338 */
1339 logUrl?: LogUrl;
1340 /**
1341 * URL to the artifact for the execution step.
1342 */
1343 artifactsUrl?: ArtifactsUrl;
1344 /**
1345 * URL to the test artifact for the execution step.
1346 */
1347 testArtifactsUrl?: TestArtifactsUrl;
1348 /**
1349 * URL to the test config for the execution step.
1350 */
1351 testConfigUrl?: TestConfigUrl;
1352 /**
1353 * List of screenshot URLs for the execution step, if relevant.
1354 */
1355 screenshots?: Screenshots;
1356 /**
1357 * The reason for current step status.
1358 */
1359 statusReason?: StatusReason;
1360 /**
1361 * The context for current step, will include build image if step is build.
1362 */
1363 context?: Context;
1364 }
1365 export type StepName = string;
1366 export type Steps = Step[];
1367 export interface StopJobRequest {
1368 /**
1369 * Unique Id for an Amplify App.
1370 */
1371 appId: AppId;
1372 /**
1373 * Name for the branch, for the Job.
1374 */
1375 branchName: BranchName;
1376 /**
1377 * Unique Id for the Job.
1378 */
1379 jobId: JobId;
1380 }
1381 export interface StopJobResult {
1382 /**
1383 * Summary for the Job.
1384 */
1385 jobSummary: JobSummary;
1386 }
1387 export interface SubDomain {
1388 /**
1389 * Setting structure for the Subdomain.
1390 */
1391 subDomainSetting: SubDomainSetting;
1392 /**
1393 * Verified status of the Subdomain
1394 */
1395 verified: Verified;
1396 /**
1397 * DNS record for the Subdomain.
1398 */
1399 dnsRecord: DNSRecord;
1400 }
1401 export interface SubDomainSetting {
1402 /**
1403 * Prefix setting for the Subdomain.
1404 */
1405 prefix: DomainPrefix;
1406 /**
1407 * Branch name setting for the Subdomain.
1408 */
1409 branchName: BranchName;
1410 }
1411 export type SubDomainSettings = SubDomainSetting[];
1412 export type SubDomains = SubDomain[];
1413 export type TTL = string;
1414 export type TagKey = string;
1415 export type TagKeyList = TagKey[];
1416 export type TagMap = {[key: string]: TagValue};
1417 export interface TagResourceRequest {
1418 /**
1419 * Resource arn used to tag resource.
1420 */
1421 resourceArn: ResourceArn;
1422 /**
1423 * Tags used to tag resource.
1424 */
1425 tags: TagMap;
1426 }
1427 export interface TagResourceResponse {
1428 }
1429 export type TagValue = string;
1430 export type Target = string;
1431 export type TestArtifactsUrl = string;
1432 export type TestConfigUrl = string;
1433 export type ThumbnailName = string;
1434 export type ThumbnailUrl = string;
1435 export type TotalNumberOfJobs = string;
1436 export interface UntagResourceRequest {
1437 /**
1438 * Resource arn used to untag resource.
1439 */
1440 resourceArn: ResourceArn;
1441 /**
1442 * Tag keys used to untag resource.
1443 */
1444 tagKeys: TagKeyList;
1445 }
1446 export interface UntagResourceResponse {
1447 }
1448 export interface UpdateAppRequest {
1449 /**
1450 * Unique Id for an Amplify App.
1451 */
1452 appId: AppId;
1453 /**
1454 * Name for an Amplify App.
1455 */
1456 name?: Name;
1457 /**
1458 * Description for an Amplify App.
1459 */
1460 description?: Description;
1461 /**
1462 * Platform for an Amplify App.
1463 */
1464 platform?: Platform;
1465 /**
1466 * IAM service role for an Amplify App.
1467 */
1468 iamServiceRoleArn?: ServiceRoleArn;
1469 /**
1470 * Environment Variables for an Amplify App.
1471 */
1472 environmentVariables?: EnvironmentVariables;
1473 /**
1474 * Enables branch auto-building for an Amplify App.
1475 */
1476 enableBranchAutoBuild?: EnableAutoBuild;
1477 /**
1478 * Enables Basic Authorization for an Amplify App.
1479 */
1480 enableBasicAuth?: EnableBasicAuth;
1481 /**
1482 * Basic Authorization credentials for an Amplify App.
1483 */
1484 basicAuthCredentials?: BasicAuthCredentials;
1485 /**
1486 * Custom redirect / rewrite rules for an Amplify App.
1487 */
1488 customRules?: CustomRules;
1489 /**
1490 * BuildSpec for an Amplify App.
1491 */
1492 buildSpec?: BuildSpec;
1493 /**
1494 * Enables automated branch creation for the Amplify App.
1495 */
1496 enableAutoBranchCreation?: EnableAutoBranchCreation;
1497 /**
1498 * Automated branch creation glob patterns for the Amplify App.
1499 */
1500 autoBranchCreationPatterns?: AutoBranchCreationPatterns;
1501 /**
1502 * Automated branch creation branchConfig for the Amplify App.
1503 */
1504 autoBranchCreationConfig?: AutoBranchCreationConfig;
1505 /**
1506 * Repository for an Amplify App
1507 */
1508 repository?: Repository;
1509 /**
1510 * 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.
1511 */
1512 oauthToken?: OauthToken;
1513 /**
1514 * Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.
1515 */
1516 accessToken?: AccessToken;
1517 }
1518 export interface UpdateAppResult {
1519 /**
1520 * App structure for the updated App.
1521 */
1522 app: App;
1523 }
1524 export interface UpdateBranchRequest {
1525 /**
1526 * Unique Id for an Amplify App.
1527 */
1528 appId: AppId;
1529 /**
1530 * Name for the branch.
1531 */
1532 branchName: BranchName;
1533 /**
1534 * Description for the branch.
1535 */
1536 description?: Description;
1537 /**
1538 * Framework for the branch.
1539 */
1540 framework?: Framework;
1541 /**
1542 * Stage for the branch.
1543 */
1544 stage?: Stage;
1545 /**
1546 * Enables notifications for the branch.
1547 */
1548 enableNotification?: EnableNotification;
1549 /**
1550 * Enables auto building for the branch.
1551 */
1552 enableAutoBuild?: EnableAutoBuild;
1553 /**
1554 * Environment Variables for the branch.
1555 */
1556 environmentVariables?: EnvironmentVariables;
1557 /**
1558 * Basic Authorization credentials for the branch.
1559 */
1560 basicAuthCredentials?: BasicAuthCredentials;
1561 /**
1562 * Enables Basic Auth for the branch.
1563 */
1564 enableBasicAuth?: EnableBasicAuth;
1565 /**
1566 * BuildSpec for the branch.
1567 */
1568 buildSpec?: BuildSpec;
1569 /**
1570 * The content TTL for the website in seconds.
1571 */
1572 ttl?: TTL;
1573 /**
1574 * Display name for a branch, will use as the default domain prefix.
1575 */
1576 displayName?: DisplayName;
1577 /**
1578 * Enables Pull Request Preview for this branch.
1579 */
1580 enablePullRequestPreview?: EnablePullRequestPreview;
1581 }
1582 export interface UpdateBranchResult {
1583 /**
1584 * Branch structure for an Amplify App.
1585 */
1586 branch: Branch;
1587 }
1588 export interface UpdateDomainAssociationRequest {
1589 /**
1590 * Unique Id for an Amplify App.
1591 */
1592 appId: AppId;
1593 /**
1594 * Name of the domain.
1595 */
1596 domainName: DomainName;
1597 /**
1598 * Enables automated creation of Subdomains for branches.
1599 */
1600 enableAutoSubDomain?: EnableAutoSubDomain;
1601 /**
1602 * Setting structure for the Subdomain.
1603 */
1604 subDomainSettings: SubDomainSettings;
1605 }
1606 export interface UpdateDomainAssociationResult {
1607 /**
1608 * Domain Association structure.
1609 */
1610 domainAssociation: DomainAssociation;
1611 }
1612 export type UpdateTime = Date;
1613 export interface UpdateWebhookRequest {
1614 /**
1615 * Unique Id for a webhook.
1616 */
1617 webhookId: WebhookId;
1618 /**
1619 * Name for a branch, part of an Amplify App.
1620 */
1621 branchName?: BranchName;
1622 /**
1623 * Description for a webhook.
1624 */
1625 description?: Description;
1626 }
1627 export interface UpdateWebhookResult {
1628 /**
1629 * Webhook structure.
1630 */
1631 webhook: Webhook;
1632 }
1633 export type UploadUrl = string;
1634 export type Verified = boolean;
1635 export interface Webhook {
1636 /**
1637 * ARN for the webhook.
1638 */
1639 webhookArn: WebhookArn;
1640 /**
1641 * Id of the webhook.
1642 */
1643 webhookId: WebhookId;
1644 /**
1645 * Url of the webhook.
1646 */
1647 webhookUrl: WebhookUrl;
1648 /**
1649 * Name for a branch, part of an Amplify App.
1650 */
1651 branchName: BranchName;
1652 /**
1653 * Description for a webhook.
1654 */
1655 description: Description;
1656 /**
1657 * Create date / time for a webhook.
1658 */
1659 createTime: CreateTime;
1660 /**
1661 * Update date / time for a webhook.
1662 */
1663 updateTime: UpdateTime;
1664 }
1665 export type WebhookArn = string;
1666 export type WebhookId = string;
1667 export type WebhookUrl = string;
1668 export type Webhooks = Webhook[];
1669 /**
1670 * 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.
1671 */
1672 export type apiVersion = "2017-07-25"|"latest"|string;
1673 export interface ClientApiVersions {
1674 /**
1675 * 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.
1676 */
1677 apiVersion?: apiVersion;
1678 }
1679 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1680 /**
1681 * Contains interfaces for use with the Amplify client.
1682 */
1683 export import Types = Amplify;
1684}
1685export = Amplify;