UNPKG

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