@aws-sdk/client-appconfig 3.312.0 → 3.316.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.
@@ -43,481 +43,314 @@ import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput } from ".
43
43
  import { UpdateExtensionAssociationCommandInput, UpdateExtensionAssociationCommandOutput } from "./commands/UpdateExtensionAssociationCommand";
44
44
  import { UpdateExtensionCommandInput, UpdateExtensionCommandOutput } from "./commands/UpdateExtensionCommand";
45
45
  import { ValidateConfigurationCommandInput, ValidateConfigurationCommandOutput } from "./commands/ValidateConfigurationCommand";
46
- /**
47
- * @public
48
- * <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly
49
- * deploy application configurations. AppConfig supports controlled deployments to
50
- * applications of any size and includes built-in validation checks and monitoring. You can
51
- * use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers,
52
- * mobile applications, or IoT devices.</p>
53
- * <p>To prevent errors when deploying application configurations, especially for production
54
- * systems where a simple typo could cause an unexpected outage, AppConfig includes
55
- * validators. A validator provides a syntactic or semantic check to ensure that the
56
- * configuration you want to deploy works as intended. To validate your application
57
- * configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
58
- * the configuration. The configuration deployment or update can only proceed when the
59
- * configuration data is valid.</p>
60
- * <p>During a configuration deployment, AppConfig monitors the application to
61
- * ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can
62
- * configure a deployment strategy for each application or environment that includes
63
- * deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error
64
- * monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back
65
- * to the previous version. </p>
66
- * <p>AppConfig supports multiple use cases. Here are some examples:</p>
67
- * <ul>
68
- * <li>
69
- * <p>
70
- * <b>Feature flags</b>: Use AppConfig to turn on
71
- * new features that require a timely deployment, such as a product launch or
72
- * announcement. </p>
73
- * </li>
74
- * <li>
75
- * <p>
76
- * <b>Application tuning</b>: Use AppConfig to
77
- * carefully introduce changes to your application that can only be tested with
78
- * production traffic.</p>
79
- * </li>
80
- * <li>
81
- * <p>
82
- * <b>Allow list</b>: Use AppConfig to allow
83
- * premium subscribers to access paid content. </p>
84
- * </li>
85
- * <li>
86
- * <p>
87
- * <b>Operational issues</b>: Use AppConfig to
88
- * reduce stress on your application when a dependency or other external factor impacts
89
- * the system.</p>
90
- * </li>
91
- * </ul>
92
- * <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User
93
- * Guide</a>.</p>
94
- */
95
- export declare class AppConfig extends AppConfigClient {
46
+ export interface AppConfig {
96
47
  /**
97
- * @public
98
- * <p>Creates an application. In AppConfig, an application is simply an
99
- * organizational construct like a folder. This organizational construct has a relationship
100
- * with some unit of executable code. For example, you could create an application called
101
- * MyMobileApp to organize and manage configuration data for a mobile application installed by
102
- * your users.</p>
48
+ * @see {@link CreateApplicationCommand}
103
49
  */
104
50
  createApplication(args: CreateApplicationCommandInput, options?: __HttpHandlerOptions): Promise<CreateApplicationCommandOutput>;
105
51
  createApplication(args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void): void;
106
52
  createApplication(args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void): void;
107
53
  /**
108
- * @public
109
- * <p>Creates a configuration profile, which is information that enables AppConfig
110
- * to access the configuration source. Valid configuration sources include the
111
- * following:</p>
112
- * <ul>
113
- * <li>
114
- * <p>Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store</p>
115
- * </li>
116
- * <li>
117
- * <p>Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3)
118
- * bucket</p>
119
- * </li>
120
- * <li>
121
- * <p>Pipelines stored in CodePipeline</p>
122
- * </li>
123
- * <li>
124
- * <p>Secrets stored in Secrets Manager</p>
125
- * </li>
126
- * <li>
127
- * <p>Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store</p>
128
- * </li>
129
- * <li>
130
- * <p>Configuration data in SSM documents stored in the Systems Manager document store</p>
131
- * </li>
132
- * </ul>
133
- * <p>A configuration profile includes the following information:</p>
134
- * <ul>
135
- * <li>
136
- * <p>The URI location of the configuration data.</p>
137
- * </li>
138
- * <li>
139
- * <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p>
140
- * </li>
141
- * <li>
142
- * <p>A validator for the configuration data. Available validators include either a JSON
143
- * Schema or an Amazon Web Services Lambda function.</p>
144
- * </li>
145
- * </ul>
146
- * <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
147
- * Configuration and a Configuration Profile</a> in the <i>AppConfig
148
- * User Guide</i>.</p>
54
+ * @see {@link CreateConfigurationProfileCommand}
149
55
  */
150
56
  createConfigurationProfile(args: CreateConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateConfigurationProfileCommandOutput>;
151
57
  createConfigurationProfile(args: CreateConfigurationProfileCommandInput, cb: (err: any, data?: CreateConfigurationProfileCommandOutput) => void): void;
152
58
  createConfigurationProfile(args: CreateConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationProfileCommandOutput) => void): void;
153
59
  /**
154
- * @public
155
- * <p>Creates a deployment strategy that defines important criteria for rolling out your
156
- * configuration to the designated targets. A deployment strategy includes the overall
157
- * duration required, a percentage of targets to receive the deployment during each interval,
158
- * an algorithm that defines how percentage grows, and bake time.</p>
60
+ * @see {@link CreateDeploymentStrategyCommand}
159
61
  */
160
62
  createDeploymentStrategy(args: CreateDeploymentStrategyCommandInput, options?: __HttpHandlerOptions): Promise<CreateDeploymentStrategyCommandOutput>;
161
63
  createDeploymentStrategy(args: CreateDeploymentStrategyCommandInput, cb: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void): void;
162
64
  createDeploymentStrategy(args: CreateDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void): void;
163
65
  /**
164
- * @public
165
- * <p>Creates an environment. For each application, you define one or more environments. An
166
- * environment is a deployment group of AppConfig targets, such as applications in a
167
- * <code>Beta</code> or <code>Production</code> environment. You can also define
168
- * environments for application subcomponents such as the <code>Web</code>,
169
- * <code>Mobile</code> and <code>Back-end</code> components for your application. You can
170
- * configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a
171
- * configuration deployment. If an alarm is triggered, the system rolls back the
172
- * configuration.</p>
66
+ * @see {@link CreateEnvironmentCommand}
173
67
  */
174
68
  createEnvironment(args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentCommandOutput>;
175
69
  createEnvironment(args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
176
70
  createEnvironment(args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
177
71
  /**
178
- * @public
179
- * <p>Creates an AppConfig extension. An extension augments your ability to inject
180
- * logic or behavior at different points during the AppConfig workflow of creating
181
- * or deploying a configuration.</p>
182
- * <p>You can create your own extensions or use the Amazon Web Services authored extensions provided by
183
- * AppConfig. For most use cases, to create your own extension, you must create
184
- * an Lambda function to perform any computation and processing defined in the
185
- * extension. For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
186
- * AppConfig extensions</a> in the
187
- * <i>AppConfig User Guide</i>.</p>
72
+ * @see {@link CreateExtensionCommand}
188
73
  */
189
74
  createExtension(args: CreateExtensionCommandInput, options?: __HttpHandlerOptions): Promise<CreateExtensionCommandOutput>;
190
75
  createExtension(args: CreateExtensionCommandInput, cb: (err: any, data?: CreateExtensionCommandOutput) => void): void;
191
76
  createExtension(args: CreateExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExtensionCommandOutput) => void): void;
192
77
  /**
193
- * @public
194
- * <p>When you create an extension or configure an Amazon Web Services authored extension, you
195
- * associate the extension with an AppConfig application, environment, or
196
- * configuration profile. For example, you can choose to run the <code>AppConfig
197
- * deployment events to Amazon SNS</code>
198
- * Amazon Web Services authored extension and receive notifications on an Amazon SNS
199
- * topic anytime a configuration deployment is started for a specific application. Defining
200
- * which extension to associate with an AppConfig resource is called an
201
- * <i>extension association</i>. An extension association is a specified
202
- * relationship between an extension and an AppConfig resource, such as an
203
- * application or a configuration profile. For more information about extensions and
204
- * associations, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
205
- * AppConfig extensions</a> in the
206
- * <i>AppConfig User Guide</i>.</p>
78
+ * @see {@link CreateExtensionAssociationCommand}
207
79
  */
208
80
  createExtensionAssociation(args: CreateExtensionAssociationCommandInput, options?: __HttpHandlerOptions): Promise<CreateExtensionAssociationCommandOutput>;
209
81
  createExtensionAssociation(args: CreateExtensionAssociationCommandInput, cb: (err: any, data?: CreateExtensionAssociationCommandOutput) => void): void;
210
82
  createExtensionAssociation(args: CreateExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExtensionAssociationCommandOutput) => void): void;
211
83
  /**
212
- * @public
213
- * <p>Creates a new configuration in the AppConfig hosted configuration
214
- * store.</p>
84
+ * @see {@link CreateHostedConfigurationVersionCommand}
215
85
  */
216
86
  createHostedConfigurationVersion(args: CreateHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateHostedConfigurationVersionCommandOutput>;
217
87
  createHostedConfigurationVersion(args: CreateHostedConfigurationVersionCommandInput, cb: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void): void;
218
88
  createHostedConfigurationVersion(args: CreateHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void): void;
219
89
  /**
220
- * @public
221
- * <p>Deletes an application. Deleting an application does not delete a configuration from a
222
- * host.</p>
90
+ * @see {@link DeleteApplicationCommand}
223
91
  */
224
92
  deleteApplication(args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteApplicationCommandOutput>;
225
93
  deleteApplication(args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void): void;
226
94
  deleteApplication(args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void): void;
227
95
  /**
228
- * @public
229
- * <p>Deletes a configuration profile. Deleting a configuration profile does not delete a
230
- * configuration from a host.</p>
96
+ * @see {@link DeleteConfigurationProfileCommand}
231
97
  */
232
98
  deleteConfigurationProfile(args: DeleteConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigurationProfileCommandOutput>;
233
99
  deleteConfigurationProfile(args: DeleteConfigurationProfileCommandInput, cb: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void): void;
234
100
  deleteConfigurationProfile(args: DeleteConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void): void;
235
101
  /**
236
- * @public
237
- * <p>Deletes a deployment strategy. Deleting a deployment strategy does not delete a
238
- * configuration from a host.</p>
102
+ * @see {@link DeleteDeploymentStrategyCommand}
239
103
  */
240
104
  deleteDeploymentStrategy(args: DeleteDeploymentStrategyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDeploymentStrategyCommandOutput>;
241
105
  deleteDeploymentStrategy(args: DeleteDeploymentStrategyCommandInput, cb: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void): void;
242
106
  deleteDeploymentStrategy(args: DeleteDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void): void;
243
107
  /**
244
- * @public
245
- * <p>Deletes an environment. Deleting an environment does not delete a configuration from a
246
- * host.</p>
108
+ * @see {@link DeleteEnvironmentCommand}
247
109
  */
248
110
  deleteEnvironment(args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentCommandOutput>;
249
111
  deleteEnvironment(args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
250
112
  deleteEnvironment(args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
251
113
  /**
252
- * @public
253
- * <p>Deletes an AppConfig extension. You must delete all associations to an
254
- * extension before you delete the extension.</p>
114
+ * @see {@link DeleteExtensionCommand}
255
115
  */
256
116
  deleteExtension(args: DeleteExtensionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExtensionCommandOutput>;
257
117
  deleteExtension(args: DeleteExtensionCommandInput, cb: (err: any, data?: DeleteExtensionCommandOutput) => void): void;
258
118
  deleteExtension(args: DeleteExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExtensionCommandOutput) => void): void;
259
119
  /**
260
- * @public
261
- * <p>Deletes an extension association. This action doesn't delete extensions defined in the
262
- * association.</p>
120
+ * @see {@link DeleteExtensionAssociationCommand}
263
121
  */
264
122
  deleteExtensionAssociation(args: DeleteExtensionAssociationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExtensionAssociationCommandOutput>;
265
123
  deleteExtensionAssociation(args: DeleteExtensionAssociationCommandInput, cb: (err: any, data?: DeleteExtensionAssociationCommandOutput) => void): void;
266
124
  deleteExtensionAssociation(args: DeleteExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExtensionAssociationCommandOutput) => void): void;
267
125
  /**
268
- * @public
269
- * <p>Deletes a version of a configuration from the AppConfig hosted configuration
270
- * store.</p>
126
+ * @see {@link DeleteHostedConfigurationVersionCommand}
271
127
  */
272
128
  deleteHostedConfigurationVersion(args: DeleteHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHostedConfigurationVersionCommandOutput>;
273
129
  deleteHostedConfigurationVersion(args: DeleteHostedConfigurationVersionCommandInput, cb: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void): void;
274
130
  deleteHostedConfigurationVersion(args: DeleteHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void): void;
275
131
  /**
276
- * @public
277
- * <p>Retrieves information about an application.</p>
132
+ * @see {@link GetApplicationCommand}
278
133
  */
279
134
  getApplication(args: GetApplicationCommandInput, options?: __HttpHandlerOptions): Promise<GetApplicationCommandOutput>;
280
135
  getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void;
281
136
  getApplication(args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void): void;
282
137
  /**
283
- * @public
284
- * @deprecated
285
- *
286
- * <p>(Deprecated) Retrieves the latest deployed configuration.</p>
287
- * <important>
288
- * <p>Note the following important information.</p>
289
- * <ul>
290
- * <li>
291
- * <p>This API action is deprecated. Calls to receive configuration data should use
292
- * the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html">GetLatestConfiguration</a> APIs instead. </p>
293
- * </li>
294
- * <li>
295
- * <p>
296
- * <code>GetConfiguration</code> is a priced call. For more information, see
297
- * <a href="https://aws.amazon.com/systems-manager/pricing/">Pricing</a>.</p>
298
- * </li>
299
- * </ul>
300
- * </important>
138
+ * @see {@link GetConfigurationCommand}
301
139
  */
302
140
  getConfiguration(args: GetConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetConfigurationCommandOutput>;
303
141
  getConfiguration(args: GetConfigurationCommandInput, cb: (err: any, data?: GetConfigurationCommandOutput) => void): void;
304
142
  getConfiguration(args: GetConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationCommandOutput) => void): void;
305
143
  /**
306
- * @public
307
- * <p>Retrieves information about a configuration profile.</p>
144
+ * @see {@link GetConfigurationProfileCommand}
308
145
  */
309
146
  getConfigurationProfile(args: GetConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetConfigurationProfileCommandOutput>;
310
147
  getConfigurationProfile(args: GetConfigurationProfileCommandInput, cb: (err: any, data?: GetConfigurationProfileCommandOutput) => void): void;
311
148
  getConfigurationProfile(args: GetConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationProfileCommandOutput) => void): void;
312
149
  /**
313
- * @public
314
- * <p>Retrieves information about a configuration deployment.</p>
150
+ * @see {@link GetDeploymentCommand}
315
151
  */
316
152
  getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<GetDeploymentCommandOutput>;
317
153
  getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void;
318
154
  getDeployment(args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void;
319
155
  /**
320
- * @public
321
- * <p>Retrieves information about a deployment strategy. A deployment strategy defines
322
- * important criteria for rolling out your configuration to the designated targets. A
323
- * deployment strategy includes the overall duration required, a percentage of targets to
324
- * receive the deployment during each interval, an algorithm that defines how percentage
325
- * grows, and bake time.</p>
156
+ * @see {@link GetDeploymentStrategyCommand}
326
157
  */
327
158
  getDeploymentStrategy(args: GetDeploymentStrategyCommandInput, options?: __HttpHandlerOptions): Promise<GetDeploymentStrategyCommandOutput>;
328
159
  getDeploymentStrategy(args: GetDeploymentStrategyCommandInput, cb: (err: any, data?: GetDeploymentStrategyCommandOutput) => void): void;
329
160
  getDeploymentStrategy(args: GetDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentStrategyCommandOutput) => void): void;
330
161
  /**
331
- * @public
332
- * <p>Retrieves information about an environment. An environment is a deployment group of
333
- * AppConfig applications, such as applications in a <code>Production</code>
334
- * environment or in an <code>EU_Region</code> environment. Each configuration deployment
335
- * targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If
336
- * an alarm is triggered during a deployment, AppConfig roles back the
337
- * configuration.</p>
162
+ * @see {@link GetEnvironmentCommand}
338
163
  */
339
164
  getEnvironment(args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentCommandOutput>;
340
165
  getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
341
166
  getEnvironment(args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
342
167
  /**
343
- * @public
344
- * <p>Returns information about an AppConfig extension.</p>
168
+ * @see {@link GetExtensionCommand}
345
169
  */
346
170
  getExtension(args: GetExtensionCommandInput, options?: __HttpHandlerOptions): Promise<GetExtensionCommandOutput>;
347
171
  getExtension(args: GetExtensionCommandInput, cb: (err: any, data?: GetExtensionCommandOutput) => void): void;
348
172
  getExtension(args: GetExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExtensionCommandOutput) => void): void;
349
173
  /**
350
- * @public
351
- * <p>Returns information about an AppConfig extension association. For more
352
- * information about extensions and associations, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
353
- * AppConfig extensions</a> in the
354
- * <i>AppConfig User Guide</i>.</p>
174
+ * @see {@link GetExtensionAssociationCommand}
355
175
  */
356
176
  getExtensionAssociation(args: GetExtensionAssociationCommandInput, options?: __HttpHandlerOptions): Promise<GetExtensionAssociationCommandOutput>;
357
177
  getExtensionAssociation(args: GetExtensionAssociationCommandInput, cb: (err: any, data?: GetExtensionAssociationCommandOutput) => void): void;
358
178
  getExtensionAssociation(args: GetExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExtensionAssociationCommandOutput) => void): void;
359
179
  /**
360
- * @public
361
- * <p>Retrieves information about a specific configuration version.</p>
180
+ * @see {@link GetHostedConfigurationVersionCommand}
362
181
  */
363
182
  getHostedConfigurationVersion(args: GetHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions): Promise<GetHostedConfigurationVersionCommandOutput>;
364
183
  getHostedConfigurationVersion(args: GetHostedConfigurationVersionCommandInput, cb: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void): void;
365
184
  getHostedConfigurationVersion(args: GetHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void): void;
366
185
  /**
367
- * @public
368
- * <p>Lists all applications in your Amazon Web Services account.</p>
186
+ * @see {@link ListApplicationsCommand}
369
187
  */
370
188
  listApplications(args: ListApplicationsCommandInput, options?: __HttpHandlerOptions): Promise<ListApplicationsCommandOutput>;
371
189
  listApplications(args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void): void;
372
190
  listApplications(args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void): void;
373
191
  /**
374
- * @public
375
- * <p>Lists the configuration profiles for an application.</p>
192
+ * @see {@link ListConfigurationProfilesCommand}
376
193
  */
377
194
  listConfigurationProfiles(args: ListConfigurationProfilesCommandInput, options?: __HttpHandlerOptions): Promise<ListConfigurationProfilesCommandOutput>;
378
195
  listConfigurationProfiles(args: ListConfigurationProfilesCommandInput, cb: (err: any, data?: ListConfigurationProfilesCommandOutput) => void): void;
379
196
  listConfigurationProfiles(args: ListConfigurationProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationProfilesCommandOutput) => void): void;
380
197
  /**
381
- * @public
382
- * <p>Lists the deployments for an environment in descending deployment number order.</p>
198
+ * @see {@link ListDeploymentsCommand}
383
199
  */
384
200
  listDeployments(args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentsCommandOutput>;
385
201
  listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
386
202
  listDeployments(args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
387
203
  /**
388
- * @public
389
- * <p>Lists deployment strategies.</p>
204
+ * @see {@link ListDeploymentStrategiesCommand}
390
205
  */
391
206
  listDeploymentStrategies(args: ListDeploymentStrategiesCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentStrategiesCommandOutput>;
392
207
  listDeploymentStrategies(args: ListDeploymentStrategiesCommandInput, cb: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void): void;
393
208
  listDeploymentStrategies(args: ListDeploymentStrategiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void): void;
394
209
  /**
395
- * @public
396
- * <p>Lists the environments for an application.</p>
210
+ * @see {@link ListEnvironmentsCommand}
397
211
  */
398
212
  listEnvironments(args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentsCommandOutput>;
399
213
  listEnvironments(args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
400
214
  listEnvironments(args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
401
215
  /**
402
- * @public
403
- * <p>Lists all AppConfig extension associations in the account. For more
404
- * information about extensions and associations, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
405
- * AppConfig extensions</a> in the
406
- * <i>AppConfig User Guide</i>.</p>
216
+ * @see {@link ListExtensionAssociationsCommand}
407
217
  */
408
218
  listExtensionAssociations(args: ListExtensionAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<ListExtensionAssociationsCommandOutput>;
409
219
  listExtensionAssociations(args: ListExtensionAssociationsCommandInput, cb: (err: any, data?: ListExtensionAssociationsCommandOutput) => void): void;
410
220
  listExtensionAssociations(args: ListExtensionAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensionAssociationsCommandOutput) => void): void;
411
221
  /**
412
- * @public
413
- * <p>Lists all custom and Amazon Web Services authored AppConfig extensions in the
414
- * account. For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
415
- * AppConfig extensions</a> in the
416
- * <i>AppConfig User Guide</i>.</p>
222
+ * @see {@link ListExtensionsCommand}
417
223
  */
418
224
  listExtensions(args: ListExtensionsCommandInput, options?: __HttpHandlerOptions): Promise<ListExtensionsCommandOutput>;
419
225
  listExtensions(args: ListExtensionsCommandInput, cb: (err: any, data?: ListExtensionsCommandOutput) => void): void;
420
226
  listExtensions(args: ListExtensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensionsCommandOutput) => void): void;
421
227
  /**
422
- * @public
423
- * <p>Lists configurations stored in the AppConfig hosted configuration store by
424
- * version.</p>
228
+ * @see {@link ListHostedConfigurationVersionsCommand}
425
229
  */
426
230
  listHostedConfigurationVersions(args: ListHostedConfigurationVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListHostedConfigurationVersionsCommandOutput>;
427
231
  listHostedConfigurationVersions(args: ListHostedConfigurationVersionsCommandInput, cb: (err: any, data?: ListHostedConfigurationVersionsCommandOutput) => void): void;
428
232
  listHostedConfigurationVersions(args: ListHostedConfigurationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostedConfigurationVersionsCommandOutput) => void): void;
429
233
  /**
430
- * @public
431
- * <p>Retrieves the list of key-value tags assigned to the resource.</p>
234
+ * @see {@link ListTagsForResourceCommand}
432
235
  */
433
236
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
434
237
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
435
238
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
436
239
  /**
437
- * @public
438
- * <p>Starts a deployment.</p>
240
+ * @see {@link StartDeploymentCommand}
439
241
  */
440
242
  startDeployment(args: StartDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<StartDeploymentCommandOutput>;
441
243
  startDeployment(args: StartDeploymentCommandInput, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void;
442
244
  startDeployment(args: StartDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void;
443
245
  /**
444
- * @public
445
- * <p>Stops a deployment. This API action works only on deployments that have a status of
446
- * <code>DEPLOYING</code>. This action moves the deployment to a status of
447
- * <code>ROLLED_BACK</code>.</p>
246
+ * @see {@link StopDeploymentCommand}
448
247
  */
449
248
  stopDeployment(args: StopDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<StopDeploymentCommandOutput>;
450
249
  stopDeployment(args: StopDeploymentCommandInput, cb: (err: any, data?: StopDeploymentCommandOutput) => void): void;
451
250
  stopDeployment(args: StopDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDeploymentCommandOutput) => void): void;
452
251
  /**
453
- * @public
454
- * <p>Assigns metadata to an AppConfig resource. Tags help organize and categorize
455
- * your AppConfig resources. Each tag consists of a key and an optional value, both
456
- * of which you define. You can specify a maximum of 50 tags for a resource.</p>
252
+ * @see {@link TagResourceCommand}
457
253
  */
458
254
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
459
255
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
460
256
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
461
257
  /**
462
- * @public
463
- * <p>Deletes a tag key and value from an AppConfig resource.</p>
258
+ * @see {@link UntagResourceCommand}
464
259
  */
465
260
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
466
261
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
467
262
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
468
263
  /**
469
- * @public
470
- * <p>Updates an application.</p>
264
+ * @see {@link UpdateApplicationCommand}
471
265
  */
472
266
  updateApplication(args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateApplicationCommandOutput>;
473
267
  updateApplication(args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void): void;
474
268
  updateApplication(args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void): void;
475
269
  /**
476
- * @public
477
- * <p>Updates a configuration profile.</p>
270
+ * @see {@link UpdateConfigurationProfileCommand}
478
271
  */
479
272
  updateConfigurationProfile(args: UpdateConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConfigurationProfileCommandOutput>;
480
273
  updateConfigurationProfile(args: UpdateConfigurationProfileCommandInput, cb: (err: any, data?: UpdateConfigurationProfileCommandOutput) => void): void;
481
274
  updateConfigurationProfile(args: UpdateConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationProfileCommandOutput) => void): void;
482
275
  /**
483
- * @public
484
- * <p>Updates a deployment strategy.</p>
276
+ * @see {@link UpdateDeploymentStrategyCommand}
485
277
  */
486
278
  updateDeploymentStrategy(args: UpdateDeploymentStrategyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDeploymentStrategyCommandOutput>;
487
279
  updateDeploymentStrategy(args: UpdateDeploymentStrategyCommandInput, cb: (err: any, data?: UpdateDeploymentStrategyCommandOutput) => void): void;
488
280
  updateDeploymentStrategy(args: UpdateDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeploymentStrategyCommandOutput) => void): void;
489
281
  /**
490
- * @public
491
- * <p>Updates an environment.</p>
282
+ * @see {@link UpdateEnvironmentCommand}
492
283
  */
493
284
  updateEnvironment(args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentCommandOutput>;
494
285
  updateEnvironment(args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void): void;
495
286
  updateEnvironment(args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void): void;
496
287
  /**
497
- * @public
498
- * <p>Updates an AppConfig extension. For more information about extensions, see
499
- * <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
500
- * AppConfig extensions</a> in the
501
- * <i>AppConfig User Guide</i>.</p>
288
+ * @see {@link UpdateExtensionCommand}
502
289
  */
503
290
  updateExtension(args: UpdateExtensionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateExtensionCommandOutput>;
504
291
  updateExtension(args: UpdateExtensionCommandInput, cb: (err: any, data?: UpdateExtensionCommandOutput) => void): void;
505
292
  updateExtension(args: UpdateExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExtensionCommandOutput) => void): void;
506
293
  /**
507
- * @public
508
- * <p>Updates an association. For more information about extensions and associations, see
509
- * <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
510
- * AppConfig extensions</a> in the
511
- * <i>AppConfig User Guide</i>.</p>
294
+ * @see {@link UpdateExtensionAssociationCommand}
512
295
  */
513
296
  updateExtensionAssociation(args: UpdateExtensionAssociationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateExtensionAssociationCommandOutput>;
514
297
  updateExtensionAssociation(args: UpdateExtensionAssociationCommandInput, cb: (err: any, data?: UpdateExtensionAssociationCommandOutput) => void): void;
515
298
  updateExtensionAssociation(args: UpdateExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExtensionAssociationCommandOutput) => void): void;
516
299
  /**
517
- * @public
518
- * <p>Uses the validators in a configuration profile to validate a configuration.</p>
300
+ * @see {@link ValidateConfigurationCommand}
519
301
  */
520
302
  validateConfiguration(args: ValidateConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<ValidateConfigurationCommandOutput>;
521
303
  validateConfiguration(args: ValidateConfigurationCommandInput, cb: (err: any, data?: ValidateConfigurationCommandOutput) => void): void;
522
304
  validateConfiguration(args: ValidateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateConfigurationCommandOutput) => void): void;
523
305
  }
306
+ /**
307
+ * @public
308
+ * <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly
309
+ * deploy application configurations. AppConfig supports controlled deployments to
310
+ * applications of any size and includes built-in validation checks and monitoring. You can
311
+ * use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers,
312
+ * mobile applications, or IoT devices.</p>
313
+ * <p>To prevent errors when deploying application configurations, especially for production
314
+ * systems where a simple typo could cause an unexpected outage, AppConfig includes
315
+ * validators. A validator provides a syntactic or semantic check to ensure that the
316
+ * configuration you want to deploy works as intended. To validate your application
317
+ * configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
318
+ * the configuration. The configuration deployment or update can only proceed when the
319
+ * configuration data is valid.</p>
320
+ * <p>During a configuration deployment, AppConfig monitors the application to
321
+ * ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can
322
+ * configure a deployment strategy for each application or environment that includes
323
+ * deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error
324
+ * monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back
325
+ * to the previous version. </p>
326
+ * <p>AppConfig supports multiple use cases. Here are some examples:</p>
327
+ * <ul>
328
+ * <li>
329
+ * <p>
330
+ * <b>Feature flags</b>: Use AppConfig to turn on
331
+ * new features that require a timely deployment, such as a product launch or
332
+ * announcement. </p>
333
+ * </li>
334
+ * <li>
335
+ * <p>
336
+ * <b>Application tuning</b>: Use AppConfig to
337
+ * carefully introduce changes to your application that can only be tested with
338
+ * production traffic.</p>
339
+ * </li>
340
+ * <li>
341
+ * <p>
342
+ * <b>Allow list</b>: Use AppConfig to allow
343
+ * premium subscribers to access paid content. </p>
344
+ * </li>
345
+ * <li>
346
+ * <p>
347
+ * <b>Operational issues</b>: Use AppConfig to
348
+ * reduce stress on your application when a dependency or other external factor impacts
349
+ * the system.</p>
350
+ * </li>
351
+ * </ul>
352
+ * <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User
353
+ * Guide</a>.</p>
354
+ */
355
+ export declare class AppConfig extends AppConfigClient implements AppConfig {
356
+ }
@@ -172,7 +172,7 @@ import {
172
172
  ValidateConfigurationCommandInput,
173
173
  ValidateConfigurationCommandOutput,
174
174
  } from "./commands/ValidateConfigurationCommand";
175
- export declare class AppConfig extends AppConfigClient {
175
+ export interface AppConfig {
176
176
  createApplication(
177
177
  args: CreateApplicationCommandInput,
178
178
  options?: __HttpHandlerOptions
@@ -733,3 +733,4 @@ export declare class AppConfig extends AppConfigClient {
733
733
  cb: (err: any, data?: ValidateConfigurationCommandOutput) => void
734
734
  ): void;
735
735
  }
736
+ export declare class AppConfig extends AppConfigClient implements AppConfig {}