@aws-sdk/client-appconfig 3.41.0 → 3.46.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.
- package/CHANGELOG.md +47 -0
- package/README.md +19 -24
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +29 -2
- package/dist-cjs/protocols/Aws_restJson1.js +49 -0
- package/dist-cjs/runtimeConfig.js +0 -2
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +28 -1
- package/dist-es/protocols/Aws_restJson1.js +51 -4
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/AppConfig.d.ts +75 -70
- package/dist-types/AppConfigClient.d.ts +19 -23
- package/dist-types/commands/CreateApplicationCommand.d.ts +5 -4
- package/dist-types/commands/CreateConfigurationProfileCommand.d.ts +13 -9
- package/dist-types/commands/CreateDeploymentStrategyCommand.d.ts +4 -4
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +8 -7
- package/dist-types/commands/CreateHostedConfigurationVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteApplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteConfigurationProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDeploymentStrategyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteHostedConfigurationVersionCommand.d.ts +2 -1
- package/dist-types/commands/GetApplicationCommand.d.ts +1 -1
- package/dist-types/commands/GetConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/GetConfigurationProfileCommand.d.ts +1 -1
- package/dist-types/commands/GetDeploymentCommand.d.ts +1 -1
- package/dist-types/commands/GetDeploymentStrategyCommand.d.ts +2 -2
- package/dist-types/commands/GetEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/GetHostedConfigurationVersionCommand.d.ts +1 -1
- package/dist-types/commands/ListApplicationsCommand.d.ts +1 -1
- package/dist-types/commands/ListDeploymentStrategiesCommand.d.ts +1 -1
- package/dist-types/commands/ListEnvironmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListHostedConfigurationVersionsCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +5 -3
- package/dist-types/models/models_0.d.ts +152 -46
- package/dist-types/ts3.4/models/models_0.d.ts +53 -1
- package/package.json +36 -43
|
@@ -34,29 +34,25 @@ import { UpdateDeploymentStrategyCommandInput, UpdateDeploymentStrategyCommandOu
|
|
|
34
34
|
import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput } from "./commands/UpdateEnvironmentCommand";
|
|
35
35
|
import { ValidateConfigurationCommandInput, ValidateConfigurationCommandOutput } from "./commands/ValidateConfigurationCommand";
|
|
36
36
|
/**
|
|
37
|
-
* <
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
|
|
37
|
+
* <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
|
|
38
|
+
* application configurations. AppConfig supports controlled deployments to applications of
|
|
39
|
+
* any size and includes built-in validation checks and monitoring. You can use AppConfig with
|
|
40
|
+
* applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
|
|
42
41
|
* devices.</p>
|
|
43
|
-
*
|
|
44
42
|
* <p>To prevent errors when deploying application configurations, especially for production
|
|
45
|
-
* systems where a simple typo could cause an unexpected outage, AppConfig includes
|
|
46
|
-
* A validator provides a syntactic or semantic check to ensure that the
|
|
47
|
-
* want to deploy works as intended. To validate your application
|
|
48
|
-
* provide a schema or a Lambda function that runs against the
|
|
49
|
-
* configuration deployment or update can only proceed when the
|
|
50
|
-
* valid.</p>
|
|
51
|
-
*
|
|
43
|
+
* systems where a simple typo could cause an unexpected outage, AppConfig includes
|
|
44
|
+
* validators. A validator provides a syntactic or semantic check to ensure that the
|
|
45
|
+
* configuration you want to deploy works as intended. To validate your application
|
|
46
|
+
* configuration data, you provide a schema or a Lambda function that runs against the
|
|
47
|
+
* configuration. The configuration deployment or update can only proceed when the
|
|
48
|
+
* configuration data is valid.</p>
|
|
52
49
|
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
|
|
53
|
-
* deployment is successful. If the system encounters an error, AppConfig rolls back the
|
|
54
|
-
* to minimize impact for your application users. You can configure a deployment
|
|
55
|
-
* each application or environment that includes deployment criteria, including
|
|
56
|
-
* time, and alarms to monitor. Similar to error monitoring, if a deployment
|
|
57
|
-
* alarm, AppConfig automatically rolls back to the previous version. </p>
|
|
58
|
-
*
|
|
59
|
-
* <p>AppConfig supports multiple use cases. Here are some examples.</p>
|
|
50
|
+
* deployment is successful. If the system encounters an error, AppConfig rolls back the
|
|
51
|
+
* change to minimize impact for your application users. You can configure a deployment
|
|
52
|
+
* strategy for each application or environment that includes deployment criteria, including
|
|
53
|
+
* velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
|
|
54
|
+
* triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
|
|
55
|
+
* <p>AppConfig supports multiple use cases. Here are some examples:</p>
|
|
60
56
|
* <ul>
|
|
61
57
|
* <li>
|
|
62
58
|
* <p>
|
|
@@ -77,118 +73,125 @@ import { ValidateConfigurationCommandInput, ValidateConfigurationCommandOutput }
|
|
|
77
73
|
* </li>
|
|
78
74
|
* <li>
|
|
79
75
|
* <p>
|
|
80
|
-
* <b>Operational issues</b>: Use AppConfig to reduce
|
|
81
|
-
* on your application when a dependency or other external factor impacts the
|
|
76
|
+
* <b>Operational issues</b>: Use AppConfig to reduce
|
|
77
|
+
* stress on your application when a dependency or other external factor impacts the
|
|
82
78
|
* system.</p>
|
|
83
79
|
* </li>
|
|
84
80
|
* </ul>
|
|
85
|
-
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/
|
|
81
|
+
* <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 Guide</a>.</p>
|
|
86
82
|
*/
|
|
87
83
|
export declare class AppConfig extends AppConfigClient {
|
|
88
84
|
/**
|
|
89
|
-
* <p>An application in AppConfig is a logical unit of code that
|
|
90
|
-
* customers. For example, an application can be a microservice
|
|
91
|
-
* a mobile application installed by your users, a serverless
|
|
92
|
-
* Gateway and
|
|
85
|
+
* <p>Creates an application. An application in AppConfig is a logical unit of code that
|
|
86
|
+
* provides capabilities for your customers. For example, an application can be a microservice
|
|
87
|
+
* that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless
|
|
88
|
+
* application using Amazon API Gateway and Lambda, or any system you run on behalf of
|
|
89
|
+
* others.</p>
|
|
93
90
|
*/
|
|
94
91
|
createApplication(args: CreateApplicationCommandInput, options?: __HttpHandlerOptions): Promise<CreateApplicationCommandOutput>;
|
|
95
92
|
createApplication(args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void): void;
|
|
96
93
|
createApplication(args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void): void;
|
|
97
94
|
/**
|
|
98
|
-
* <p>
|
|
99
|
-
* configuration
|
|
100
|
-
* Amazon
|
|
95
|
+
* <p>Creates a configuration profile, which is information that enables AppConfig to access
|
|
96
|
+
* the configuration source. Valid configuration sources include the AppConfig hosted
|
|
97
|
+
* configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3
|
|
98
|
+
* objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
|
|
99
|
+
* action</a> supported by CodePipeline. A configuration profile includes the following
|
|
100
|
+
* information:</p>
|
|
101
|
+
*
|
|
101
102
|
* <ul>
|
|
102
103
|
* <li>
|
|
103
|
-
* <p>The
|
|
104
|
+
* <p>The URI location of the configuration data.</p>
|
|
104
105
|
* </li>
|
|
105
106
|
* <li>
|
|
106
|
-
* <p>The
|
|
107
|
+
* <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p>
|
|
107
108
|
* </li>
|
|
108
109
|
* <li>
|
|
109
110
|
* <p>A validator for the configuration data. Available validators include either a JSON
|
|
110
|
-
* Schema or an
|
|
111
|
+
* Schema or an Lambda function.</p>
|
|
111
112
|
* </li>
|
|
112
113
|
* </ul>
|
|
113
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/
|
|
114
|
-
* Configuration and a Configuration Profile</a> in the
|
|
115
|
-
*
|
|
114
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
|
|
115
|
+
* Configuration and a Configuration Profile</a> in the <i>AppConfig User
|
|
116
|
+
* Guide</i>.</p>
|
|
116
117
|
*/
|
|
117
118
|
createConfigurationProfile(args: CreateConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateConfigurationProfileCommandOutput>;
|
|
118
119
|
createConfigurationProfile(args: CreateConfigurationProfileCommandInput, cb: (err: any, data?: CreateConfigurationProfileCommandOutput) => void): void;
|
|
119
120
|
createConfigurationProfile(args: CreateConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationProfileCommandOutput) => void): void;
|
|
120
121
|
/**
|
|
121
|
-
* <p>
|
|
122
|
-
* the designated targets. A deployment strategy includes
|
|
123
|
-
* percentage of targets to receive the deployment during each interval,
|
|
124
|
-
* defines how percentage grows, and bake time.</p>
|
|
122
|
+
* <p>Creates a deployment strategy that defines important criteria for rolling out your
|
|
123
|
+
* configuration to the designated targets. A deployment strategy includes the overall
|
|
124
|
+
* duration required, a percentage of targets to receive the deployment during each interval,
|
|
125
|
+
* an algorithm that defines how percentage grows, and bake time.</p>
|
|
125
126
|
*/
|
|
126
127
|
createDeploymentStrategy(args: CreateDeploymentStrategyCommandInput, options?: __HttpHandlerOptions): Promise<CreateDeploymentStrategyCommandOutput>;
|
|
127
128
|
createDeploymentStrategy(args: CreateDeploymentStrategyCommandInput, cb: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void): void;
|
|
128
129
|
createDeploymentStrategy(args: CreateDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void): void;
|
|
129
130
|
/**
|
|
130
|
-
* <p>For each application, you define one or more environments. An
|
|
131
|
-
* deployment group of AppConfig targets, such as applications in a
|
|
132
|
-
* <code>Production</code> environment. You can also define
|
|
133
|
-
* subcomponents such as the <code>Web</code>,
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
* system rolls back the
|
|
131
|
+
* <p>Creates an environment. For each application, you define one or more environments. An
|
|
132
|
+
* environment is a logical deployment group of AppConfig targets, such as applications in a
|
|
133
|
+
* <code>Beta</code> or <code>Production</code> environment. You can also define
|
|
134
|
+
* environments for application subcomponents such as the <code>Web</code>,
|
|
135
|
+
* <code>Mobile</code> and <code>Back-end</code> components for your application. You can
|
|
136
|
+
* configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a
|
|
137
|
+
* configuration deployment. If an alarm is triggered, the system rolls back the
|
|
138
|
+
* configuration.</p>
|
|
137
139
|
*/
|
|
138
140
|
createEnvironment(args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentCommandOutput>;
|
|
139
141
|
createEnvironment(args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
|
|
140
142
|
createEnvironment(args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
|
|
141
143
|
/**
|
|
142
|
-
* <p>
|
|
144
|
+
* <p>Creates a new configuration in the AppConfig hosted configuration store.</p>
|
|
143
145
|
*/
|
|
144
146
|
createHostedConfigurationVersion(args: CreateHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateHostedConfigurationVersionCommandOutput>;
|
|
145
147
|
createHostedConfigurationVersion(args: CreateHostedConfigurationVersionCommandInput, cb: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void): void;
|
|
146
148
|
createHostedConfigurationVersion(args: CreateHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void): void;
|
|
147
149
|
/**
|
|
148
|
-
* <p>
|
|
150
|
+
* <p>Deletes an application. Deleting an application does not delete a configuration from a
|
|
149
151
|
* host.</p>
|
|
150
152
|
*/
|
|
151
153
|
deleteApplication(args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteApplicationCommandOutput>;
|
|
152
154
|
deleteApplication(args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void): void;
|
|
153
155
|
deleteApplication(args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void): void;
|
|
154
156
|
/**
|
|
155
|
-
* <p>
|
|
157
|
+
* <p>Deletes a configuration profile. Deleting a configuration profile does not delete a
|
|
156
158
|
* configuration from a host.</p>
|
|
157
159
|
*/
|
|
158
160
|
deleteConfigurationProfile(args: DeleteConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigurationProfileCommandOutput>;
|
|
159
161
|
deleteConfigurationProfile(args: DeleteConfigurationProfileCommandInput, cb: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void): void;
|
|
160
162
|
deleteConfigurationProfile(args: DeleteConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void): void;
|
|
161
163
|
/**
|
|
162
|
-
* <p>
|
|
164
|
+
* <p>Deletes a deployment strategy. Deleting a deployment strategy does not delete a
|
|
163
165
|
* configuration from a host.</p>
|
|
164
166
|
*/
|
|
165
167
|
deleteDeploymentStrategy(args: DeleteDeploymentStrategyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDeploymentStrategyCommandOutput>;
|
|
166
168
|
deleteDeploymentStrategy(args: DeleteDeploymentStrategyCommandInput, cb: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void): void;
|
|
167
169
|
deleteDeploymentStrategy(args: DeleteDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void): void;
|
|
168
170
|
/**
|
|
169
|
-
* <p>
|
|
171
|
+
* <p>Deletes an environment. Deleting an environment does not delete a configuration from a
|
|
170
172
|
* host.</p>
|
|
171
173
|
*/
|
|
172
174
|
deleteEnvironment(args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentCommandOutput>;
|
|
173
175
|
deleteEnvironment(args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
|
|
174
176
|
deleteEnvironment(args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
|
|
175
177
|
/**
|
|
176
|
-
* <p>
|
|
178
|
+
* <p>Deletes a version of a configuration from the AppConfig hosted configuration
|
|
179
|
+
* store.</p>
|
|
177
180
|
*/
|
|
178
181
|
deleteHostedConfigurationVersion(args: DeleteHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHostedConfigurationVersionCommandOutput>;
|
|
179
182
|
deleteHostedConfigurationVersion(args: DeleteHostedConfigurationVersionCommandInput, cb: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void): void;
|
|
180
183
|
deleteHostedConfigurationVersion(args: DeleteHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void): void;
|
|
181
184
|
/**
|
|
182
|
-
* <p>
|
|
185
|
+
* <p>Retrieves information about an application.</p>
|
|
183
186
|
*/
|
|
184
187
|
getApplication(args: GetApplicationCommandInput, options?: __HttpHandlerOptions): Promise<GetApplicationCommandOutput>;
|
|
185
188
|
getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void;
|
|
186
189
|
getApplication(args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void): void;
|
|
187
190
|
/**
|
|
188
|
-
* <p>
|
|
191
|
+
* <p>Retrieves information about a configuration.</p>
|
|
189
192
|
* <important>
|
|
190
|
-
* <p>
|
|
191
|
-
*
|
|
193
|
+
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter to
|
|
194
|
+
* identify the configuration version on your clients. If you don’t send
|
|
192
195
|
* <code>ClientConfigurationVersion</code> with each call to
|
|
193
196
|
* <code>GetConfiguration</code>, your clients receive the current configuration. You
|
|
194
197
|
* are charged each time your clients receive a configuration.</p>
|
|
@@ -203,21 +206,21 @@ export declare class AppConfig extends AppConfigClient {
|
|
|
203
206
|
getConfiguration(args: GetConfigurationCommandInput, cb: (err: any, data?: GetConfigurationCommandOutput) => void): void;
|
|
204
207
|
getConfiguration(args: GetConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationCommandOutput) => void): void;
|
|
205
208
|
/**
|
|
206
|
-
* <p>
|
|
209
|
+
* <p>Retrieves information about a configuration profile.</p>
|
|
207
210
|
*/
|
|
208
211
|
getConfigurationProfile(args: GetConfigurationProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetConfigurationProfileCommandOutput>;
|
|
209
212
|
getConfigurationProfile(args: GetConfigurationProfileCommandInput, cb: (err: any, data?: GetConfigurationProfileCommandOutput) => void): void;
|
|
210
213
|
getConfigurationProfile(args: GetConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationProfileCommandOutput) => void): void;
|
|
211
214
|
/**
|
|
212
|
-
* <p>
|
|
215
|
+
* <p>Retrieves information about a configuration deployment.</p>
|
|
213
216
|
*/
|
|
214
217
|
getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<GetDeploymentCommandOutput>;
|
|
215
218
|
getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void;
|
|
216
219
|
getDeployment(args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void;
|
|
217
220
|
/**
|
|
218
|
-
* <p>
|
|
221
|
+
* <p>Retrieves information about a deployment strategy. A deployment strategy defines
|
|
219
222
|
* important criteria for rolling out your configuration to the designated targets. A
|
|
220
|
-
* deployment strategy includes
|
|
223
|
+
* deployment strategy includes the overall duration required, a percentage of targets to
|
|
221
224
|
* receive the deployment during each interval, an algorithm that defines how percentage
|
|
222
225
|
* grows, and bake time.</p>
|
|
223
226
|
*/
|
|
@@ -225,7 +228,7 @@ export declare class AppConfig extends AppConfigClient {
|
|
|
225
228
|
getDeploymentStrategy(args: GetDeploymentStrategyCommandInput, cb: (err: any, data?: GetDeploymentStrategyCommandOutput) => void): void;
|
|
226
229
|
getDeploymentStrategy(args: GetDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentStrategyCommandOutput) => void): void;
|
|
227
230
|
/**
|
|
228
|
-
* <p>
|
|
231
|
+
* <p>Retrieves information about an environment. An environment is a logical deployment group
|
|
229
232
|
* of AppConfig applications, such as applications in a <code>Production</code> environment or
|
|
230
233
|
* in an <code>EU_Region</code> environment. Each configuration deployment targets an
|
|
231
234
|
* environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is
|
|
@@ -235,13 +238,13 @@ export declare class AppConfig extends AppConfigClient {
|
|
|
235
238
|
getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
|
|
236
239
|
getEnvironment(args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
|
|
237
240
|
/**
|
|
238
|
-
* <p>
|
|
241
|
+
* <p>Retrieves information about a specific configuration version.</p>
|
|
239
242
|
*/
|
|
240
243
|
getHostedConfigurationVersion(args: GetHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions): Promise<GetHostedConfigurationVersionCommandOutput>;
|
|
241
244
|
getHostedConfigurationVersion(args: GetHostedConfigurationVersionCommandInput, cb: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void): void;
|
|
242
245
|
getHostedConfigurationVersion(args: GetHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void): void;
|
|
243
246
|
/**
|
|
244
|
-
* <p>
|
|
247
|
+
* <p>Lists all applications in your Amazon Web Services account.</p>
|
|
245
248
|
*/
|
|
246
249
|
listApplications(args: ListApplicationsCommandInput, options?: __HttpHandlerOptions): Promise<ListApplicationsCommandOutput>;
|
|
247
250
|
listApplications(args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void): void;
|
|
@@ -259,19 +262,19 @@ export declare class AppConfig extends AppConfigClient {
|
|
|
259
262
|
listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
|
|
260
263
|
listDeployments(args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
|
|
261
264
|
/**
|
|
262
|
-
* <p>
|
|
265
|
+
* <p>Lists deployment strategies.</p>
|
|
263
266
|
*/
|
|
264
267
|
listDeploymentStrategies(args: ListDeploymentStrategiesCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentStrategiesCommandOutput>;
|
|
265
268
|
listDeploymentStrategies(args: ListDeploymentStrategiesCommandInput, cb: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void): void;
|
|
266
269
|
listDeploymentStrategies(args: ListDeploymentStrategiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void): void;
|
|
267
270
|
/**
|
|
268
|
-
* <p>
|
|
271
|
+
* <p>Lists the environments for an application.</p>
|
|
269
272
|
*/
|
|
270
273
|
listEnvironments(args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentsCommandOutput>;
|
|
271
274
|
listEnvironments(args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
|
|
272
275
|
listEnvironments(args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
|
|
273
276
|
/**
|
|
274
|
-
* <p>
|
|
277
|
+
* <p>Lists configurations stored in the AppConfig hosted configuration store by
|
|
275
278
|
* version.</p>
|
|
276
279
|
*/
|
|
277
280
|
listHostedConfigurationVersions(args: ListHostedConfigurationVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListHostedConfigurationVersionsCommandOutput>;
|
|
@@ -298,9 +301,11 @@ export declare class AppConfig extends AppConfigClient {
|
|
|
298
301
|
stopDeployment(args: StopDeploymentCommandInput, cb: (err: any, data?: StopDeploymentCommandOutput) => void): void;
|
|
299
302
|
stopDeployment(args: StopDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDeploymentCommandOutput) => void): void;
|
|
300
303
|
/**
|
|
301
|
-
* <p>
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
+
* <p>Assigns
|
|
305
|
+
* metadata
|
|
306
|
+
* to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each
|
|
307
|
+
* tag consists of a key and an optional value, both of which you define. You can specify a
|
|
308
|
+
* maximum of 50 tags for a resource.</p>
|
|
304
309
|
*/
|
|
305
310
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
306
311
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
@@ -155,29 +155,25 @@ declare type AppConfigClientResolvedConfigType = __SmithyResolvedConfiguration<_
|
|
|
155
155
|
export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedConfigType {
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
158
|
-
* <
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
* applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
|
|
158
|
+
* <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
|
|
159
|
+
* application configurations. AppConfig supports controlled deployments to applications of
|
|
160
|
+
* any size and includes built-in validation checks and monitoring. You can use AppConfig with
|
|
161
|
+
* applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
|
|
163
162
|
* devices.</p>
|
|
164
|
-
*
|
|
165
163
|
* <p>To prevent errors when deploying application configurations, especially for production
|
|
166
|
-
* systems where a simple typo could cause an unexpected outage, AppConfig includes
|
|
167
|
-
* A validator provides a syntactic or semantic check to ensure that the
|
|
168
|
-
* want to deploy works as intended. To validate your application
|
|
169
|
-
* provide a schema or a Lambda function that runs against the
|
|
170
|
-
* configuration deployment or update can only proceed when the
|
|
171
|
-
* valid.</p>
|
|
172
|
-
*
|
|
164
|
+
* systems where a simple typo could cause an unexpected outage, AppConfig includes
|
|
165
|
+
* validators. A validator provides a syntactic or semantic check to ensure that the
|
|
166
|
+
* configuration you want to deploy works as intended. To validate your application
|
|
167
|
+
* configuration data, you provide a schema or a Lambda function that runs against the
|
|
168
|
+
* configuration. The configuration deployment or update can only proceed when the
|
|
169
|
+
* configuration data is valid.</p>
|
|
173
170
|
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
|
|
174
|
-
* deployment is successful. If the system encounters an error, AppConfig rolls back the
|
|
175
|
-
* to minimize impact for your application users. You can configure a deployment
|
|
176
|
-
* each application or environment that includes deployment criteria, including
|
|
177
|
-
* time, and alarms to monitor. Similar to error monitoring, if a deployment
|
|
178
|
-
* alarm, AppConfig automatically rolls back to the previous version. </p>
|
|
179
|
-
*
|
|
180
|
-
* <p>AppConfig supports multiple use cases. Here are some examples.</p>
|
|
171
|
+
* deployment is successful. If the system encounters an error, AppConfig rolls back the
|
|
172
|
+
* change to minimize impact for your application users. You can configure a deployment
|
|
173
|
+
* strategy for each application or environment that includes deployment criteria, including
|
|
174
|
+
* velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
|
|
175
|
+
* triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
|
|
176
|
+
* <p>AppConfig supports multiple use cases. Here are some examples:</p>
|
|
181
177
|
* <ul>
|
|
182
178
|
* <li>
|
|
183
179
|
* <p>
|
|
@@ -198,12 +194,12 @@ export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedCo
|
|
|
198
194
|
* </li>
|
|
199
195
|
* <li>
|
|
200
196
|
* <p>
|
|
201
|
-
* <b>Operational issues</b>: Use AppConfig to reduce
|
|
202
|
-
* on your application when a dependency or other external factor impacts the
|
|
197
|
+
* <b>Operational issues</b>: Use AppConfig to reduce
|
|
198
|
+
* stress on your application when a dependency or other external factor impacts the
|
|
203
199
|
* system.</p>
|
|
204
200
|
* </li>
|
|
205
201
|
* </ul>
|
|
206
|
-
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/
|
|
202
|
+
* <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 Guide</a>.</p>
|
|
207
203
|
*/
|
|
208
204
|
export declare class AppConfigClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AppConfigClientResolvedConfig> {
|
|
209
205
|
/**
|
|
@@ -7,10 +7,11 @@ export interface CreateApplicationCommandInput extends CreateApplicationRequest
|
|
|
7
7
|
export interface CreateApplicationCommandOutput extends Application, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>An application in AppConfig is a logical unit of code that
|
|
11
|
-
* customers. For example, an application can be a microservice
|
|
12
|
-
* a mobile application installed by your users, a serverless
|
|
13
|
-
* Gateway and
|
|
10
|
+
* <p>Creates an application. An application in AppConfig is a logical unit of code that
|
|
11
|
+
* provides capabilities for your customers. For example, an application can be a microservice
|
|
12
|
+
* that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless
|
|
13
|
+
* application using Amazon API Gateway and Lambda, or any system you run on behalf of
|
|
14
|
+
* others.</p>
|
|
14
15
|
* @example
|
|
15
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
17
|
* ```javascript
|
|
@@ -7,24 +7,28 @@ export interface CreateConfigurationProfileCommandInput extends CreateConfigurat
|
|
|
7
7
|
export interface CreateConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* configuration
|
|
12
|
-
* Amazon
|
|
10
|
+
* <p>Creates a configuration profile, which is information that enables AppConfig to access
|
|
11
|
+
* the configuration source. Valid configuration sources include the AppConfig hosted
|
|
12
|
+
* configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3
|
|
13
|
+
* objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
|
|
14
|
+
* action</a> supported by CodePipeline. A configuration profile includes the following
|
|
15
|
+
* information:</p>
|
|
16
|
+
*
|
|
13
17
|
* <ul>
|
|
14
18
|
* <li>
|
|
15
|
-
* <p>The
|
|
19
|
+
* <p>The URI location of the configuration data.</p>
|
|
16
20
|
* </li>
|
|
17
21
|
* <li>
|
|
18
|
-
* <p>The
|
|
22
|
+
* <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p>
|
|
19
23
|
* </li>
|
|
20
24
|
* <li>
|
|
21
25
|
* <p>A validator for the configuration data. Available validators include either a JSON
|
|
22
|
-
* Schema or an
|
|
26
|
+
* Schema or an Lambda function.</p>
|
|
23
27
|
* </li>
|
|
24
28
|
* </ul>
|
|
25
|
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/
|
|
26
|
-
* Configuration and a Configuration Profile</a> in the
|
|
27
|
-
*
|
|
29
|
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
|
|
30
|
+
* Configuration and a Configuration Profile</a> in the <i>AppConfig User
|
|
31
|
+
* Guide</i>.</p>
|
|
28
32
|
* @example
|
|
29
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
34
|
* ```javascript
|
|
@@ -7,10 +7,10 @@ export interface CreateDeploymentStrategyCommandInput extends CreateDeploymentSt
|
|
|
7
7
|
export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrategy, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* the designated targets. A deployment strategy includes
|
|
12
|
-
* percentage of targets to receive the deployment during each interval,
|
|
13
|
-
* defines how percentage grows, and bake time.</p>
|
|
10
|
+
* <p>Creates a deployment strategy that defines important criteria for rolling out your
|
|
11
|
+
* configuration to the designated targets. A deployment strategy includes the overall
|
|
12
|
+
* duration required, a percentage of targets to receive the deployment during each interval,
|
|
13
|
+
* an algorithm that defines how percentage grows, and bake time.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -7,13 +7,14 @@ export interface CreateEnvironmentCommandInput extends CreateEnvironmentRequest
|
|
|
7
7
|
export interface CreateEnvironmentCommandOutput extends Environment, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>For each application, you define one or more environments. An
|
|
11
|
-
* deployment group of AppConfig targets, such as applications in a
|
|
12
|
-
* <code>Production</code> environment. You can also define
|
|
13
|
-
* subcomponents such as the <code>Web</code>,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* system rolls back the
|
|
10
|
+
* <p>Creates an environment. For each application, you define one or more environments. An
|
|
11
|
+
* environment is a logical deployment group of AppConfig targets, such as applications in a
|
|
12
|
+
* <code>Beta</code> or <code>Production</code> environment. You can also define
|
|
13
|
+
* environments for application subcomponents such as the <code>Web</code>,
|
|
14
|
+
* <code>Mobile</code> and <code>Back-end</code> components for your application. You can
|
|
15
|
+
* configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a
|
|
16
|
+
* configuration deployment. If an alarm is triggered, the system rolls back the
|
|
17
|
+
* configuration.</p>
|
|
17
18
|
* @example
|
|
18
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
20
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateHostedConfigurationVersionCommandInput extends CreateHost
|
|
|
7
7
|
export interface CreateHostedConfigurationVersionCommandOutput extends HostedConfigurationVersion, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Creates a new configuration in the AppConfig hosted configuration store.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest
|
|
|
7
7
|
export interface DeleteApplicationCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Deletes an application. Deleting an application does not delete a configuration from a
|
|
11
11
|
* host.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface DeleteConfigurationProfileCommandInput extends DeleteConfigurat
|
|
|
7
7
|
export interface DeleteConfigurationProfileCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Deletes a configuration profile. Deleting a configuration profile does not delete a
|
|
11
11
|
* configuration from a host.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface DeleteDeploymentStrategyCommandInput extends DeleteDeploymentSt
|
|
|
7
7
|
export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Deletes a deployment strategy. Deleting a deployment strategy does not delete a
|
|
11
11
|
* configuration from a host.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface DeleteEnvironmentCommandInput extends DeleteEnvironmentRequest
|
|
|
7
7
|
export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Deletes an environment. Deleting an environment does not delete a configuration from a
|
|
11
11
|
* host.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,8 @@ export interface DeleteHostedConfigurationVersionCommandInput extends DeleteHost
|
|
|
7
7
|
export interface DeleteHostedConfigurationVersionCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Deletes a version of a configuration from the AppConfig hosted configuration
|
|
11
|
+
* store.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetApplicationCommandInput extends GetApplicationRequest {
|
|
|
7
7
|
export interface GetApplicationCommandOutput extends Application, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves information about an application.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,10 +7,10 @@ export interface GetConfigurationCommandInput extends GetConfigurationRequest {
|
|
|
7
7
|
export interface GetConfigurationCommandOutput extends Configuration, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves information about a configuration.</p>
|
|
11
11
|
* <important>
|
|
12
|
-
* <p>
|
|
13
|
-
*
|
|
12
|
+
* <p>AppConfig uses the value of the <code>ClientConfigurationVersion</code> parameter to
|
|
13
|
+
* identify the configuration version on your clients. If you don’t send
|
|
14
14
|
* <code>ClientConfigurationVersion</code> with each call to
|
|
15
15
|
* <code>GetConfiguration</code>, your clients receive the current configuration. You
|
|
16
16
|
* are charged each time your clients receive a configuration.</p>
|
|
@@ -7,7 +7,7 @@ export interface GetConfigurationProfileCommandInput extends GetConfigurationPro
|
|
|
7
7
|
export interface GetConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves information about a configuration profile.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetDeploymentCommandInput extends GetDeploymentRequest {
|
|
|
7
7
|
export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves information about a configuration deployment.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface GetDeploymentStrategyCommandInput extends GetDeploymentStrategy
|
|
|
7
7
|
export interface GetDeploymentStrategyCommandOutput extends DeploymentStrategy, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves information about a deployment strategy. A deployment strategy defines
|
|
11
11
|
* important criteria for rolling out your configuration to the designated targets. A
|
|
12
|
-
* deployment strategy includes
|
|
12
|
+
* deployment strategy includes the overall duration required, a percentage of targets to
|
|
13
13
|
* receive the deployment during each interval, an algorithm that defines how percentage
|
|
14
14
|
* grows, and bake time.</p>
|
|
15
15
|
* @example
|
|
@@ -7,7 +7,7 @@ export interface GetEnvironmentCommandInput extends GetEnvironmentRequest {
|
|
|
7
7
|
export interface GetEnvironmentCommandOutput extends Environment, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Retrieves information about an environment. An environment is a logical deployment group
|
|
11
11
|
* of AppConfig applications, such as applications in a <code>Production</code> environment or
|
|
12
12
|
* in an <code>EU_Region</code> environment. Each configuration deployment targets an
|
|
13
13
|
* environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is
|