@aws-sdk/client-amplify 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist-types/Amplify.d.ts +38 -0
  2. package/dist-types/AmplifyClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAppCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateBranchCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDeploymentCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateDomainAssociationCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateWebhookCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteAppCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteBranchCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteJobCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteWebhookCommand.d.ts +16 -0
  15. package/dist-types/commands/GenerateAccessLogsCommand.d.ts +16 -0
  16. package/dist-types/commands/GetAppCommand.d.ts +16 -0
  17. package/dist-types/commands/GetArtifactUrlCommand.d.ts +16 -0
  18. package/dist-types/commands/GetBackendEnvironmentCommand.d.ts +16 -0
  19. package/dist-types/commands/GetBranchCommand.d.ts +16 -0
  20. package/dist-types/commands/GetDomainAssociationCommand.d.ts +16 -0
  21. package/dist-types/commands/GetJobCommand.d.ts +16 -0
  22. package/dist-types/commands/GetWebhookCommand.d.ts +16 -0
  23. package/dist-types/commands/ListAppsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListArtifactsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListBackendEnvironmentsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListBranchesCommand.d.ts +16 -0
  27. package/dist-types/commands/ListDomainAssociationsCommand.d.ts +16 -0
  28. package/dist-types/commands/ListJobsCommand.d.ts +16 -0
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  30. package/dist-types/commands/ListWebhooksCommand.d.ts +16 -0
  31. package/dist-types/commands/StartDeploymentCommand.d.ts +16 -0
  32. package/dist-types/commands/StartJobCommand.d.ts +16 -0
  33. package/dist-types/commands/StopJobCommand.d.ts +16 -0
  34. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  35. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  36. package/dist-types/commands/UpdateAppCommand.d.ts +16 -0
  37. package/dist-types/commands/UpdateBranchCommand.d.ts +16 -0
  38. package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +16 -0
  39. package/dist-types/commands/UpdateWebhookCommand.d.ts +16 -0
  40. package/dist-types/models/AmplifyServiceException.d.ts +2 -0
  41. package/dist-types/models/models_0.d.ts +123 -0
  42. package/package.json +29 -29
@@ -38,6 +38,7 @@ import { UpdateBranchCommandInput, UpdateBranchCommandOutput } from "./commands/
38
38
  import { UpdateDomainAssociationCommandInput, UpdateDomainAssociationCommandOutput } from "./commands/UpdateDomainAssociationCommand";
39
39
  import { UpdateWebhookCommandInput, UpdateWebhookCommandOutput } from "./commands/UpdateWebhookCommand";
40
40
  /**
41
+ * @public
41
42
  * <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
42
43
  * The Amplify Console provides a continuous delivery and hosting service for web
43
44
  * applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Console User Guide</a>. The
@@ -47,24 +48,28 @@ import { UpdateWebhookCommandInput, UpdateWebhookCommandOutput } from "./command
47
48
  */
48
49
  export declare class Amplify extends AmplifyClient {
49
50
  /**
51
+ * @public
50
52
  * <p> Creates a new Amplify app. </p>
51
53
  */
52
54
  createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise<CreateAppCommandOutput>;
53
55
  createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void;
54
56
  createApp(args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void): void;
55
57
  /**
58
+ * @public
56
59
  * <p> Creates a new backend environment for an Amplify app. </p>
57
60
  */
58
61
  createBackendEnvironment(args: CreateBackendEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateBackendEnvironmentCommandOutput>;
59
62
  createBackendEnvironment(args: CreateBackendEnvironmentCommandInput, cb: (err: any, data?: CreateBackendEnvironmentCommandOutput) => void): void;
60
63
  createBackendEnvironment(args: CreateBackendEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendEnvironmentCommandOutput) => void): void;
61
64
  /**
65
+ * @public
62
66
  * <p> Creates a new branch for an Amplify app. </p>
63
67
  */
64
68
  createBranch(args: CreateBranchCommandInput, options?: __HttpHandlerOptions): Promise<CreateBranchCommandOutput>;
65
69
  createBranch(args: CreateBranchCommandInput, cb: (err: any, data?: CreateBranchCommandOutput) => void): void;
66
70
  createBranch(args: CreateBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBranchCommandOutput) => void): void;
67
71
  /**
72
+ * @public
68
73
  * <p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
69
74
  * not connected to a repository. </p>
70
75
  */
@@ -72,6 +77,7 @@ export declare class Amplify extends AmplifyClient {
72
77
  createDeployment(args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void): void;
73
78
  createDeployment(args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void): void;
74
79
  /**
80
+ * @public
75
81
  * <p> Creates a new domain association for an Amplify app. This action associates a custom
76
82
  * domain with the Amplify app </p>
77
83
  */
@@ -79,48 +85,56 @@ export declare class Amplify extends AmplifyClient {
79
85
  createDomainAssociation(args: CreateDomainAssociationCommandInput, cb: (err: any, data?: CreateDomainAssociationCommandOutput) => void): void;
80
86
  createDomainAssociation(args: CreateDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainAssociationCommandOutput) => void): void;
81
87
  /**
88
+ * @public
82
89
  * <p> Creates a new webhook on an Amplify app. </p>
83
90
  */
84
91
  createWebhook(args: CreateWebhookCommandInput, options?: __HttpHandlerOptions): Promise<CreateWebhookCommandOutput>;
85
92
  createWebhook(args: CreateWebhookCommandInput, cb: (err: any, data?: CreateWebhookCommandOutput) => void): void;
86
93
  createWebhook(args: CreateWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebhookCommandOutput) => void): void;
87
94
  /**
95
+ * @public
88
96
  * <p> Deletes an existing Amplify app specified by an app ID. </p>
89
97
  */
90
98
  deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAppCommandOutput>;
91
99
  deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void;
92
100
  deleteApp(args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void): void;
93
101
  /**
102
+ * @public
94
103
  * <p> Deletes a backend environment for an Amplify app. </p>
95
104
  */
96
105
  deleteBackendEnvironment(args: DeleteBackendEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackendEnvironmentCommandOutput>;
97
106
  deleteBackendEnvironment(args: DeleteBackendEnvironmentCommandInput, cb: (err: any, data?: DeleteBackendEnvironmentCommandOutput) => void): void;
98
107
  deleteBackendEnvironment(args: DeleteBackendEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendEnvironmentCommandOutput) => void): void;
99
108
  /**
109
+ * @public
100
110
  * <p> Deletes a branch for an Amplify app. </p>
101
111
  */
102
112
  deleteBranch(args: DeleteBranchCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBranchCommandOutput>;
103
113
  deleteBranch(args: DeleteBranchCommandInput, cb: (err: any, data?: DeleteBranchCommandOutput) => void): void;
104
114
  deleteBranch(args: DeleteBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBranchCommandOutput) => void): void;
105
115
  /**
116
+ * @public
106
117
  * <p> Deletes a domain association for an Amplify app. </p>
107
118
  */
108
119
  deleteDomainAssociation(args: DeleteDomainAssociationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDomainAssociationCommandOutput>;
109
120
  deleteDomainAssociation(args: DeleteDomainAssociationCommandInput, cb: (err: any, data?: DeleteDomainAssociationCommandOutput) => void): void;
110
121
  deleteDomainAssociation(args: DeleteDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainAssociationCommandOutput) => void): void;
111
122
  /**
123
+ * @public
112
124
  * <p> Deletes a job for a branch of an Amplify app. </p>
113
125
  */
114
126
  deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteJobCommandOutput>;
115
127
  deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void;
116
128
  deleteJob(args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void): void;
117
129
  /**
130
+ * @public
118
131
  * <p> Deletes a webhook. </p>
119
132
  */
120
133
  deleteWebhook(args: DeleteWebhookCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWebhookCommandOutput>;
121
134
  deleteWebhook(args: DeleteWebhookCommandInput, cb: (err: any, data?: DeleteWebhookCommandOutput) => void): void;
122
135
  deleteWebhook(args: DeleteWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebhookCommandOutput) => void): void;
123
136
  /**
137
+ * @public
124
138
  * <p> Returns the website access logs for a specific time range using a presigned URL.
125
139
  * </p>
126
140
  */
@@ -128,96 +142,112 @@ export declare class Amplify extends AmplifyClient {
128
142
  generateAccessLogs(args: GenerateAccessLogsCommandInput, cb: (err: any, data?: GenerateAccessLogsCommandOutput) => void): void;
129
143
  generateAccessLogs(args: GenerateAccessLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateAccessLogsCommandOutput) => void): void;
130
144
  /**
145
+ * @public
131
146
  * <p> Returns an existing Amplify app by appID. </p>
132
147
  */
133
148
  getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise<GetAppCommandOutput>;
134
149
  getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void;
135
150
  getApp(args: GetAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppCommandOutput) => void): void;
136
151
  /**
152
+ * @public
137
153
  * <p> Returns the artifact info that corresponds to an artifact id. </p>
138
154
  */
139
155
  getArtifactUrl(args: GetArtifactUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetArtifactUrlCommandOutput>;
140
156
  getArtifactUrl(args: GetArtifactUrlCommandInput, cb: (err: any, data?: GetArtifactUrlCommandOutput) => void): void;
141
157
  getArtifactUrl(args: GetArtifactUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetArtifactUrlCommandOutput) => void): void;
142
158
  /**
159
+ * @public
143
160
  * <p> Returns a backend environment for an Amplify app. </p>
144
161
  */
145
162
  getBackendEnvironment(args: GetBackendEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<GetBackendEnvironmentCommandOutput>;
146
163
  getBackendEnvironment(args: GetBackendEnvironmentCommandInput, cb: (err: any, data?: GetBackendEnvironmentCommandOutput) => void): void;
147
164
  getBackendEnvironment(args: GetBackendEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendEnvironmentCommandOutput) => void): void;
148
165
  /**
166
+ * @public
149
167
  * <p> Returns a branch for an Amplify app. </p>
150
168
  */
151
169
  getBranch(args: GetBranchCommandInput, options?: __HttpHandlerOptions): Promise<GetBranchCommandOutput>;
152
170
  getBranch(args: GetBranchCommandInput, cb: (err: any, data?: GetBranchCommandOutput) => void): void;
153
171
  getBranch(args: GetBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBranchCommandOutput) => void): void;
154
172
  /**
173
+ * @public
155
174
  * <p> Returns the domain information for an Amplify app. </p>
156
175
  */
157
176
  getDomainAssociation(args: GetDomainAssociationCommandInput, options?: __HttpHandlerOptions): Promise<GetDomainAssociationCommandOutput>;
158
177
  getDomainAssociation(args: GetDomainAssociationCommandInput, cb: (err: any, data?: GetDomainAssociationCommandOutput) => void): void;
159
178
  getDomainAssociation(args: GetDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainAssociationCommandOutput) => void): void;
160
179
  /**
180
+ * @public
161
181
  * <p> Returns a job for a branch of an Amplify app. </p>
162
182
  */
163
183
  getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise<GetJobCommandOutput>;
164
184
  getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void;
165
185
  getJob(args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void): void;
166
186
  /**
187
+ * @public
167
188
  * <p> Returns the webhook information that corresponds to a specified webhook ID. </p>
168
189
  */
169
190
  getWebhook(args: GetWebhookCommandInput, options?: __HttpHandlerOptions): Promise<GetWebhookCommandOutput>;
170
191
  getWebhook(args: GetWebhookCommandInput, cb: (err: any, data?: GetWebhookCommandOutput) => void): void;
171
192
  getWebhook(args: GetWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebhookCommandOutput) => void): void;
172
193
  /**
194
+ * @public
173
195
  * <p> Returns a list of the existing Amplify apps. </p>
174
196
  */
175
197
  listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise<ListAppsCommandOutput>;
176
198
  listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void;
177
199
  listApps(args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void): void;
178
200
  /**
201
+ * @public
179
202
  * <p> Returns a list of artifacts for a specified app, branch, and job. </p>
180
203
  */
181
204
  listArtifacts(args: ListArtifactsCommandInput, options?: __HttpHandlerOptions): Promise<ListArtifactsCommandOutput>;
182
205
  listArtifacts(args: ListArtifactsCommandInput, cb: (err: any, data?: ListArtifactsCommandOutput) => void): void;
183
206
  listArtifacts(args: ListArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArtifactsCommandOutput) => void): void;
184
207
  /**
208
+ * @public
185
209
  * <p> Lists the backend environments for an Amplify app. </p>
186
210
  */
187
211
  listBackendEnvironments(args: ListBackendEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListBackendEnvironmentsCommandOutput>;
188
212
  listBackendEnvironments(args: ListBackendEnvironmentsCommandInput, cb: (err: any, data?: ListBackendEnvironmentsCommandOutput) => void): void;
189
213
  listBackendEnvironments(args: ListBackendEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackendEnvironmentsCommandOutput) => void): void;
190
214
  /**
215
+ * @public
191
216
  * <p> Lists the branches of an Amplify app. </p>
192
217
  */
193
218
  listBranches(args: ListBranchesCommandInput, options?: __HttpHandlerOptions): Promise<ListBranchesCommandOutput>;
194
219
  listBranches(args: ListBranchesCommandInput, cb: (err: any, data?: ListBranchesCommandOutput) => void): void;
195
220
  listBranches(args: ListBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBranchesCommandOutput) => void): void;
196
221
  /**
222
+ * @public
197
223
  * <p> Returns the domain associations for an Amplify app. </p>
198
224
  */
199
225
  listDomainAssociations(args: ListDomainAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainAssociationsCommandOutput>;
200
226
  listDomainAssociations(args: ListDomainAssociationsCommandInput, cb: (err: any, data?: ListDomainAssociationsCommandOutput) => void): void;
201
227
  listDomainAssociations(args: ListDomainAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainAssociationsCommandOutput) => void): void;
202
228
  /**
229
+ * @public
203
230
  * <p> Lists the jobs for a branch of an Amplify app. </p>
204
231
  */
205
232
  listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListJobsCommandOutput>;
206
233
  listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
207
234
  listJobs(args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
208
235
  /**
236
+ * @public
209
237
  * <p> Returns a list of tags for a specified Amazon Resource Name (ARN). </p>
210
238
  */
211
239
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
212
240
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
213
241
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
214
242
  /**
243
+ * @public
215
244
  * <p> Returns a list of webhooks for an Amplify app. </p>
216
245
  */
217
246
  listWebhooks(args: ListWebhooksCommandInput, options?: __HttpHandlerOptions): Promise<ListWebhooksCommandOutput>;
218
247
  listWebhooks(args: ListWebhooksCommandInput, cb: (err: any, data?: ListWebhooksCommandOutput) => void): void;
219
248
  listWebhooks(args: ListWebhooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebhooksCommandOutput) => void): void;
220
249
  /**
250
+ * @public
221
251
  * <p> Starts a deployment for a manually deployed app. Manually deployed apps are not
222
252
  * connected to a repository. </p>
223
253
  */
@@ -225,48 +255,56 @@ export declare class Amplify extends AmplifyClient {
225
255
  startDeployment(args: StartDeploymentCommandInput, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void;
226
256
  startDeployment(args: StartDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void;
227
257
  /**
258
+ * @public
228
259
  * <p> Starts a new job for a branch of an Amplify app. </p>
229
260
  */
230
261
  startJob(args: StartJobCommandInput, options?: __HttpHandlerOptions): Promise<StartJobCommandOutput>;
231
262
  startJob(args: StartJobCommandInput, cb: (err: any, data?: StartJobCommandOutput) => void): void;
232
263
  startJob(args: StartJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobCommandOutput) => void): void;
233
264
  /**
265
+ * @public
234
266
  * <p> Stops a job that is in progress for a branch of an Amplify app. </p>
235
267
  */
236
268
  stopJob(args: StopJobCommandInput, options?: __HttpHandlerOptions): Promise<StopJobCommandOutput>;
237
269
  stopJob(args: StopJobCommandInput, cb: (err: any, data?: StopJobCommandOutput) => void): void;
238
270
  stopJob(args: StopJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopJobCommandOutput) => void): void;
239
271
  /**
272
+ * @public
240
273
  * <p> Tags the resource with a tag key and value. </p>
241
274
  */
242
275
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
243
276
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
244
277
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
245
278
  /**
279
+ * @public
246
280
  * <p> Untags a resource with a specified Amazon Resource Name (ARN). </p>
247
281
  */
248
282
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
249
283
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
250
284
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
251
285
  /**
286
+ * @public
252
287
  * <p> Updates an existing Amplify app. </p>
253
288
  */
254
289
  updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAppCommandOutput>;
255
290
  updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void;
256
291
  updateApp(args: UpdateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppCommandOutput) => void): void;
257
292
  /**
293
+ * @public
258
294
  * <p> Updates a branch for an Amplify app. </p>
259
295
  */
260
296
  updateBranch(args: UpdateBranchCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBranchCommandOutput>;
261
297
  updateBranch(args: UpdateBranchCommandInput, cb: (err: any, data?: UpdateBranchCommandOutput) => void): void;
262
298
  updateBranch(args: UpdateBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBranchCommandOutput) => void): void;
263
299
  /**
300
+ * @public
264
301
  * <p> Creates a new domain association for an Amplify app.</p>
265
302
  */
266
303
  updateDomainAssociation(args: UpdateDomainAssociationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDomainAssociationCommandOutput>;
267
304
  updateDomainAssociation(args: UpdateDomainAssociationCommandInput, cb: (err: any, data?: UpdateDomainAssociationCommandOutput) => void): void;
268
305
  updateDomainAssociation(args: UpdateDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainAssociationCommandOutput) => void): void;
269
306
  /**
307
+ * @public
270
308
  * <p> Updates a webhook. </p>
271
309
  */
272
310
  updateWebhook(args: UpdateWebhookCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWebhookCommandOutput>;
@@ -45,15 +45,24 @@ import { UpdateBranchCommandInput, UpdateBranchCommandOutput } from "./commands/
45
45
  import { UpdateDomainAssociationCommandInput, UpdateDomainAssociationCommandOutput } from "./commands/UpdateDomainAssociationCommand";
46
46
  import { UpdateWebhookCommandInput, UpdateWebhookCommandOutput } from "./commands/UpdateWebhookCommand";
47
47
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
48
+ /**
49
+ * @public
50
+ */
48
51
  export type ServiceInputTypes = CreateAppCommandInput | CreateBackendEnvironmentCommandInput | CreateBranchCommandInput | CreateDeploymentCommandInput | CreateDomainAssociationCommandInput | CreateWebhookCommandInput | DeleteAppCommandInput | DeleteBackendEnvironmentCommandInput | DeleteBranchCommandInput | DeleteDomainAssociationCommandInput | DeleteJobCommandInput | DeleteWebhookCommandInput | GenerateAccessLogsCommandInput | GetAppCommandInput | GetArtifactUrlCommandInput | GetBackendEnvironmentCommandInput | GetBranchCommandInput | GetDomainAssociationCommandInput | GetJobCommandInput | GetWebhookCommandInput | ListAppsCommandInput | ListArtifactsCommandInput | ListBackendEnvironmentsCommandInput | ListBranchesCommandInput | ListDomainAssociationsCommandInput | ListJobsCommandInput | ListTagsForResourceCommandInput | ListWebhooksCommandInput | StartDeploymentCommandInput | StartJobCommandInput | StopJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAppCommandInput | UpdateBranchCommandInput | UpdateDomainAssociationCommandInput | UpdateWebhookCommandInput;
52
+ /**
53
+ * @public
54
+ */
49
55
  export type ServiceOutputTypes = CreateAppCommandOutput | CreateBackendEnvironmentCommandOutput | CreateBranchCommandOutput | CreateDeploymentCommandOutput | CreateDomainAssociationCommandOutput | CreateWebhookCommandOutput | DeleteAppCommandOutput | DeleteBackendEnvironmentCommandOutput | DeleteBranchCommandOutput | DeleteDomainAssociationCommandOutput | DeleteJobCommandOutput | DeleteWebhookCommandOutput | GenerateAccessLogsCommandOutput | GetAppCommandOutput | GetArtifactUrlCommandOutput | GetBackendEnvironmentCommandOutput | GetBranchCommandOutput | GetDomainAssociationCommandOutput | GetJobCommandOutput | GetWebhookCommandOutput | ListAppsCommandOutput | ListArtifactsCommandOutput | ListBackendEnvironmentsCommandOutput | ListBranchesCommandOutput | ListDomainAssociationsCommandOutput | ListJobsCommandOutput | ListTagsForResourceCommandOutput | ListWebhooksCommandOutput | StartDeploymentCommandOutput | StartJobCommandOutput | StopJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAppCommandOutput | UpdateBranchCommandOutput | UpdateDomainAssociationCommandOutput | UpdateWebhookCommandOutput;
56
+ /**
57
+ * @public
58
+ */
50
59
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
51
60
  /**
52
61
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
53
62
  */
54
63
  requestHandler?: __HttpHandler;
55
64
  /**
56
- * A constructor for a class implementing the {@link __Checksum} interface
65
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
57
66
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
58
67
  * @internal
59
68
  */
@@ -143,23 +152,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
143
152
  */
144
153
  logger?: __Logger;
145
154
  /**
146
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
155
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
147
156
  */
148
157
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
149
158
  }
159
+ /**
160
+ * @public
161
+ */
150
162
  type AmplifyClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
151
163
  /**
152
- * The configuration interface of AmplifyClient class constructor that set the region, credentials and other options.
164
+ * @public
165
+ *
166
+ * The configuration interface of AmplifyClient class constructor that set the region, credentials and other options.
153
167
  */
154
168
  export interface AmplifyClientConfig extends AmplifyClientConfigType {
155
169
  }
170
+ /**
171
+ * @public
172
+ */
156
173
  type AmplifyClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
157
174
  /**
158
- * The resolved configuration interface of AmplifyClient class. This is resolved and normalized from the {@link AmplifyClientConfig | constructor configuration interface}.
175
+ * @public
176
+ *
177
+ * The resolved configuration interface of AmplifyClient class. This is resolved and normalized from the {@link AmplifyClientConfig | constructor configuration interface}.
159
178
  */
160
179
  export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfigType {
161
180
  }
162
181
  /**
182
+ * @public
163
183
  * <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
164
184
  * The Amplify Console provides a continuous delivery and hosting service for web
165
185
  * applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Console User Guide</a>. The
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyClient";
5
5
  import { CreateAppRequest, CreateAppResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAppCommand}.
8
10
  */
9
11
  export interface CreateAppCommandInput extends CreateAppRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAppCommand}.
13
17
  */
14
18
  export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a new Amplify app. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateAppCommandInput - {@link CreateAppCommandInput}
34
+ * @returns {@link CreateAppCommandOutput}
28
35
  * @see {@link CreateAppCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateAppCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare
49
56
  export declare class CreateAppCommand extends $Command<CreateAppCommandInput, CreateAppCommandOutput, AmplifyClientResolvedConfig> {
50
57
  readonly input: CreateAppCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: CreateAppCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAppCommandInput, CreateAppCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyClient";
5
5
  import { CreateBackendEnvironmentRequest, CreateBackendEnvironmentResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBackendEnvironmentCommand}.
8
10
  */
9
11
  export interface CreateBackendEnvironmentCommandInput extends CreateBackendEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBackendEnvironmentCommand}.
13
17
  */
14
18
  export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvironmentResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a new backend environment for an Amplify app. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBackendEnvironmentCommandInput - {@link CreateBackendEnvironmentCommandInput}
34
+ * @returns {@link CreateBackendEnvironmentCommandOutput}
28
35
  * @see {@link CreateBackendEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBackendEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
49
56
  export declare class CreateBackendEnvironmentCommand extends $Command<CreateBackendEnvironmentCommandInput, CreateBackendEnvironmentCommandOutput, AmplifyClientResolvedConfig> {
50
57
  readonly input: CreateBackendEnvironmentCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: CreateBackendEnvironmentCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBackendEnvironmentCommandInput, CreateBackendEnvironmentCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyClient";
5
5
  import { CreateBranchRequest, CreateBranchResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBranchCommand}.
8
10
  */
9
11
  export interface CreateBranchCommandInput extends CreateBranchRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBranchCommand}.
13
17
  */
14
18
  export interface CreateBranchCommandOutput extends CreateBranchResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a new branch for an Amplify app. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateBranchCommandInput - {@link CreateBranchCommandInput}
34
+ * @returns {@link CreateBranchCommandOutput}
28
35
  * @see {@link CreateBranchCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateBranchCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat
52
59
  export declare class CreateBranchCommand extends $Command<CreateBranchCommandInput, CreateBranchCommandOutput, AmplifyClientResolvedConfig> {
53
60
  readonly input: CreateBranchCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateBranchCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBranchCommandInput, CreateBranchCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyClient";
5
5
  import { CreateDeploymentRequest, CreateDeploymentResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDeploymentCommand}.
8
10
  */
9
11
  export interface CreateDeploymentCommandInput extends CreateDeploymentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDeploymentCommand}.
13
17
  */
14
18
  export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
18
23
  * not connected to a repository. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateDeploymentCommandInput - {@link CreateDeploymentCommandInput}
35
+ * @returns {@link CreateDeploymentCommandOutput}
29
36
  * @see {@link CreateDeploymentCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateDeploymentCommandOutput} for command's `response` shape.
31
38
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _
47
54
  export declare class CreateDeploymentCommand extends $Command<CreateDeploymentCommandInput, CreateDeploymentCommandOutput, AmplifyClientResolvedConfig> {
48
55
  readonly input: CreateDeploymentCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: CreateDeploymentCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDeploymentCommandInput, CreateDeploymentCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyClient";
5
5
  import { CreateDomainAssociationRequest, CreateDomainAssociationResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDomainAssociationCommand}.
8
10
  */
9
11
  export interface CreateDomainAssociationCommandInput extends CreateDomainAssociationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDomainAssociationCommand}.
13
17
  */
14
18
  export interface CreateDomainAssociationCommandOutput extends CreateDomainAssociationResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a new domain association for an Amplify app. This action associates a custom
18
23
  * domain with the Amplify app </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateDomainAssociationCommandInput - {@link CreateDomainAssociationCommandInput}
35
+ * @returns {@link CreateDomainAssociationCommandOutput}
29
36
  * @see {@link CreateDomainAssociationCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateDomainAssociationCommandOutput} for command's `response` shape.
31
38
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
53
60
  export declare class CreateDomainAssociationCommand extends $Command<CreateDomainAssociationCommandInput, CreateDomainAssociationCommandOutput, AmplifyClientResolvedConfig> {
54
61
  readonly input: CreateDomainAssociationCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateDomainAssociationCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDomainAssociationCommandInput, CreateDomainAssociationCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AmplifyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyClient";
5
5
  import { CreateWebhookRequest, CreateWebhookResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateWebhookCommand}.
8
10
  */
9
11
  export interface CreateWebhookCommandInput extends CreateWebhookRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateWebhookCommand}.
13
17
  */
14
18
  export interface CreateWebhookCommandOutput extends CreateWebhookResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a new webhook on an Amplify app. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateWebhookCommandInput - {@link CreateWebhookCommandInput}
34
+ * @returns {@link CreateWebhookCommandOutput}
28
35
  * @see {@link CreateWebhookCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateWebhookCommandOutput} for command's `response` shape.
30
37
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad
52
59
  export declare class CreateWebhookCommand extends $Command<CreateWebhookCommandInput, CreateWebhookCommandOutput, AmplifyClientResolvedConfig> {
53
60
  readonly input: CreateWebhookCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateWebhookCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWebhookCommandInput, CreateWebhookCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }