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