UNPKG

46.9 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class AppConfig extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: AppConfig.Types.ClientConfiguration)
13 config: Config & AppConfig.Types.ClientConfiguration;
14 /**
15 * An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
16 */
17 createApplication(params: AppConfig.Types.CreateApplicationRequest, callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>;
18 /**
19 * An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
20 */
21 createApplication(callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>;
22 /**
23 * Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information. The Uri location of the configuration data. The AWS Identity and Access Management (IAM) role that provides access to the configuration data. A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function. For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.
24 */
25 createConfigurationProfile(params: AppConfig.Types.CreateConfigurationProfileRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>;
26 /**
27 * Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information. The Uri location of the configuration data. The AWS Identity and Access Management (IAM) role that provides access to the configuration data. A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function. For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.
28 */
29 createConfigurationProfile(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>;
30 /**
31 * A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
32 */
33 createDeploymentStrategy(params: AppConfig.Types.CreateDeploymentStrategyRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>;
34 /**
35 * A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
36 */
37 createDeploymentStrategy(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>;
38 /**
39 * For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
40 */
41 createEnvironment(params: AppConfig.Types.CreateEnvironmentRequest, callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>;
42 /**
43 * For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
44 */
45 createEnvironment(callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>;
46 /**
47 * Delete an application. Deleting an application does not delete a configuration from a host.
48 */
49 deleteApplication(params: AppConfig.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * Delete an application. Deleting an application does not delete a configuration from a host.
52 */
53 deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
56 */
57 deleteConfigurationProfile(params: AppConfig.Types.DeleteConfigurationProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58 /**
59 * Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
60 */
61 deleteConfigurationProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62 /**
63 * Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
64 */
65 deleteDeploymentStrategy(params: AppConfig.Types.DeleteDeploymentStrategyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66 /**
67 * Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
68 */
69 deleteDeploymentStrategy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70 /**
71 * Delete an environment. Deleting an environment does not delete a configuration from a host.
72 */
73 deleteEnvironment(params: AppConfig.Types.DeleteEnvironmentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74 /**
75 * Delete an environment. Deleting an environment does not delete a configuration from a host.
76 */
77 deleteEnvironment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * Retrieve information about an application.
80 */
81 getApplication(params: AppConfig.Types.GetApplicationRequest, callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>;
82 /**
83 * Retrieve information about an application.
84 */
85 getApplication(callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>;
86 /**
87 * Retrieve information about a configuration.
88 */
89 getConfiguration(params: AppConfig.Types.GetConfigurationRequest, callback?: (err: AWSError, data: AppConfig.Types.Configuration) => void): Request<AppConfig.Types.Configuration, AWSError>;
90 /**
91 * Retrieve information about a configuration.
92 */
93 getConfiguration(callback?: (err: AWSError, data: AppConfig.Types.Configuration) => void): Request<AppConfig.Types.Configuration, AWSError>;
94 /**
95 * Retrieve information about a configuration profile.
96 */
97 getConfigurationProfile(params: AppConfig.Types.GetConfigurationProfileRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>;
98 /**
99 * Retrieve information about a configuration profile.
100 */
101 getConfigurationProfile(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>;
102 /**
103 * Retrieve information about a configuration deployment.
104 */
105 getDeployment(params: AppConfig.Types.GetDeploymentRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>;
106 /**
107 * Retrieve information about a configuration deployment.
108 */
109 getDeployment(callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>;
110 /**
111 * Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
112 */
113 getDeploymentStrategy(params: AppConfig.Types.GetDeploymentStrategyRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>;
114 /**
115 * Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
116 */
117 getDeploymentStrategy(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>;
118 /**
119 * Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
120 */
121 getEnvironment(params: AppConfig.Types.GetEnvironmentRequest, callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>;
122 /**
123 * Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
124 */
125 getEnvironment(callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>;
126 /**
127 * List all applications in your AWS account.
128 */
129 listApplications(params: AppConfig.Types.ListApplicationsRequest, callback?: (err: AWSError, data: AppConfig.Types.Applications) => void): Request<AppConfig.Types.Applications, AWSError>;
130 /**
131 * List all applications in your AWS account.
132 */
133 listApplications(callback?: (err: AWSError, data: AppConfig.Types.Applications) => void): Request<AppConfig.Types.Applications, AWSError>;
134 /**
135 * Lists the configuration profiles for an application.
136 */
137 listConfigurationProfiles(params: AppConfig.Types.ListConfigurationProfilesRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfiles) => void): Request<AppConfig.Types.ConfigurationProfiles, AWSError>;
138 /**
139 * Lists the configuration profiles for an application.
140 */
141 listConfigurationProfiles(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfiles) => void): Request<AppConfig.Types.ConfigurationProfiles, AWSError>;
142 /**
143 * List deployment strategies.
144 */
145 listDeploymentStrategies(params: AppConfig.Types.ListDeploymentStrategiesRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategies) => void): Request<AppConfig.Types.DeploymentStrategies, AWSError>;
146 /**
147 * List deployment strategies.
148 */
149 listDeploymentStrategies(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategies) => void): Request<AppConfig.Types.DeploymentStrategies, AWSError>;
150 /**
151 * Lists the deployments for an environment.
152 */
153 listDeployments(params: AppConfig.Types.ListDeploymentsRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployments) => void): Request<AppConfig.Types.Deployments, AWSError>;
154 /**
155 * Lists the deployments for an environment.
156 */
157 listDeployments(callback?: (err: AWSError, data: AppConfig.Types.Deployments) => void): Request<AppConfig.Types.Deployments, AWSError>;
158 /**
159 * List the environments for an application.
160 */
161 listEnvironments(params: AppConfig.Types.ListEnvironmentsRequest, callback?: (err: AWSError, data: AppConfig.Types.Environments) => void): Request<AppConfig.Types.Environments, AWSError>;
162 /**
163 * List the environments for an application.
164 */
165 listEnvironments(callback?: (err: AWSError, data: AppConfig.Types.Environments) => void): Request<AppConfig.Types.Environments, AWSError>;
166 /**
167 * Retrieves the list of key-value tags assigned to the resource.
168 */
169 listTagsForResource(params: AppConfig.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppConfig.Types.ResourceTags) => void): Request<AppConfig.Types.ResourceTags, AWSError>;
170 /**
171 * Retrieves the list of key-value tags assigned to the resource.
172 */
173 listTagsForResource(callback?: (err: AWSError, data: AppConfig.Types.ResourceTags) => void): Request<AppConfig.Types.ResourceTags, AWSError>;
174 /**
175 * Starts a deployment.
176 */
177 startDeployment(params: AppConfig.Types.StartDeploymentRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>;
178 /**
179 * Starts a deployment.
180 */
181 startDeployment(callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>;
182 /**
183 * Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.
184 */
185 stopDeployment(params: AppConfig.Types.StopDeploymentRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>;
186 /**
187 * Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.
188 */
189 stopDeployment(callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>;
190 /**
191 * Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
192 */
193 tagResource(params: AppConfig.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
194 /**
195 * Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
196 */
197 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
198 /**
199 * Deletes a tag key and value from an AppConfig resource.
200 */
201 untagResource(params: AppConfig.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
202 /**
203 * Deletes a tag key and value from an AppConfig resource.
204 */
205 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
206 /**
207 * Updates an application.
208 */
209 updateApplication(params: AppConfig.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>;
210 /**
211 * Updates an application.
212 */
213 updateApplication(callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>;
214 /**
215 * Updates a configuration profile.
216 */
217 updateConfigurationProfile(params: AppConfig.Types.UpdateConfigurationProfileRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>;
218 /**
219 * Updates a configuration profile.
220 */
221 updateConfigurationProfile(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>;
222 /**
223 * Updates a deployment strategy.
224 */
225 updateDeploymentStrategy(params: AppConfig.Types.UpdateDeploymentStrategyRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>;
226 /**
227 * Updates a deployment strategy.
228 */
229 updateDeploymentStrategy(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>;
230 /**
231 * Updates an environment.
232 */
233 updateEnvironment(params: AppConfig.Types.UpdateEnvironmentRequest, callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>;
234 /**
235 * Updates an environment.
236 */
237 updateEnvironment(callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>;
238 /**
239 * Uses the validators in a configuration profile to validate a configuration.
240 */
241 validateConfiguration(params: AppConfig.Types.ValidateConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
242 /**
243 * Uses the validators in a configuration profile to validate a configuration.
244 */
245 validateConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
246}
247declare namespace AppConfig {
248 export interface Application {
249 /**
250 * The application ID.
251 */
252 Id?: Id;
253 /**
254 * The application name.
255 */
256 Name?: Name;
257 /**
258 * The description of the application.
259 */
260 Description?: Description;
261 }
262 export type ApplicationList = Application[];
263 export interface Applications {
264 /**
265 * The elements from this collection.
266 */
267 Items?: ApplicationList;
268 /**
269 * The token for the next set of items to return. Use this token to get the next set of results.
270 */
271 NextToken?: NextToken;
272 }
273 export type Arn = string;
274 export type _Blob = Buffer|Uint8Array|Blob|string;
275 export interface Configuration {
276 /**
277 * The content of the configuration or the configuration data.
278 */
279 Content?: _Blob;
280 /**
281 * The configuration version.
282 */
283 ConfigurationVersion?: Version;
284 /**
285 * A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
286 */
287 ContentType?: String;
288 }
289 export interface ConfigurationProfile {
290 /**
291 * The application ID.
292 */
293 ApplicationId?: Id;
294 /**
295 * The configuration profile ID.
296 */
297 Id?: Id;
298 /**
299 * The name of the configuration profile.
300 */
301 Name?: Name;
302 /**
303 * The configuration profile description.
304 */
305 Description?: Description;
306 /**
307 * The URI location of the configuration.
308 */
309 LocationUri?: Uri;
310 /**
311 * The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
312 */
313 RetrievalRoleArn?: Arn;
314 /**
315 * A list of methods for validating the configuration.
316 */
317 Validators?: ValidatorList;
318 }
319 export interface ConfigurationProfileSummary {
320 /**
321 * The application ID.
322 */
323 ApplicationId?: Id;
324 /**
325 * The ID of the configuration profile.
326 */
327 Id?: Id;
328 /**
329 * The name of the configuration profile.
330 */
331 Name?: Name;
332 /**
333 * The URI location of the configuration.
334 */
335 LocationUri?: Uri;
336 /**
337 * The types of validators in the configuration profile.
338 */
339 ValidatorTypes?: ValidatorTypeList;
340 }
341 export type ConfigurationProfileSummaryList = ConfigurationProfileSummary[];
342 export interface ConfigurationProfiles {
343 /**
344 * The elements from this collection.
345 */
346 Items?: ConfigurationProfileSummaryList;
347 /**
348 * The token for the next set of items to return. Use this token to get the next set of results.
349 */
350 NextToken?: NextToken;
351 }
352 export interface CreateApplicationRequest {
353 /**
354 * A name for the application.
355 */
356 Name: Name;
357 /**
358 * A description of the application.
359 */
360 Description?: Description;
361 /**
362 * Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
363 */
364 Tags?: TagMap;
365 }
366 export interface CreateConfigurationProfileRequest {
367 /**
368 * The application ID.
369 */
370 ApplicationId: Id;
371 /**
372 * A name for the configuration profile.
373 */
374 Name: Name;
375 /**
376 * A description of the configuration profile.
377 */
378 Description?: Description;
379 /**
380 * A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the document name in the format ssm-document://&lt;Document_name&gt; or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://&lt;Parameter_name&gt; or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://&lt;bucket&gt;/&lt;objectKey&gt; . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json
381 */
382 LocationUri: Uri;
383 /**
384 * The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
385 */
386 RetrievalRoleArn: Arn;
387 /**
388 * A list of methods for validating the configuration.
389 */
390 Validators?: ValidatorList;
391 /**
392 * Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
393 */
394 Tags?: TagMap;
395 }
396 export interface CreateDeploymentStrategyRequest {
397 /**
398 * A name for the deployment strategy.
399 */
400 Name: Name;
401 /**
402 * A description of the deployment strategy.
403 */
404 Description?: Description;
405 /**
406 * Total amount of time for a deployment to last.
407 */
408 DeploymentDurationInMinutes: MinutesBetween0And24Hours;
409 /**
410 * The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
411 */
412 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours;
413 /**
414 * The percentage of targets to receive a deployed configuration during each interval.
415 */
416 GrowthFactor: GrowthFactor;
417 /**
418 * The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: 2*(2^0) 2*(2^1) 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
419 */
420 GrowthType?: GrowthType;
421 /**
422 * Save the deployment strategy to a Systems Manager (SSM) document.
423 */
424 ReplicateTo: ReplicateTo;
425 /**
426 * Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
427 */
428 Tags?: TagMap;
429 }
430 export interface CreateEnvironmentRequest {
431 /**
432 * The application ID.
433 */
434 ApplicationId: Id;
435 /**
436 * A name for the environment.
437 */
438 Name: Name;
439 /**
440 * A description of the environment.
441 */
442 Description?: Description;
443 /**
444 * Amazon CloudWatch alarms to monitor during the deployment process.
445 */
446 Monitors?: MonitorList;
447 /**
448 * Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
449 */
450 Tags?: TagMap;
451 }
452 export interface DeleteApplicationRequest {
453 /**
454 * The ID of the application to delete.
455 */
456 ApplicationId: Id;
457 }
458 export interface DeleteConfigurationProfileRequest {
459 /**
460 * The application ID that includes the configuration profile you want to delete.
461 */
462 ApplicationId: Id;
463 /**
464 * The ID of the configuration profile you want to delete.
465 */
466 ConfigurationProfileId: Id;
467 }
468 export interface DeleteDeploymentStrategyRequest {
469 /**
470 * The ID of the deployment strategy you want to delete.
471 */
472 DeploymentStrategyId: DeploymentStrategyId;
473 }
474 export interface DeleteEnvironmentRequest {
475 /**
476 * The application ID that includes the environment you want to delete.
477 */
478 ApplicationId: Id;
479 /**
480 * The ID of the environment you want to delete.
481 */
482 EnvironmentId: Id;
483 }
484 export interface Deployment {
485 /**
486 * The ID of the application that was deployed.
487 */
488 ApplicationId?: Id;
489 /**
490 * The ID of the environment that was deployed.
491 */
492 EnvironmentId?: Id;
493 /**
494 * The ID of the deployment strategy that was deployed.
495 */
496 DeploymentStrategyId?: Id;
497 /**
498 * The ID of the configuration profile that was deployed.
499 */
500 ConfigurationProfileId?: Id;
501 /**
502 * The sequence number of the deployment.
503 */
504 DeploymentNumber?: Integer;
505 /**
506 * The name of the configuration.
507 */
508 ConfigurationName?: Name;
509 /**
510 * Information about the source location of the configuration.
511 */
512 ConfigurationLocationUri?: Uri;
513 /**
514 * The configuration version that was deployed.
515 */
516 ConfigurationVersion?: Version;
517 /**
518 * The description of the deployment.
519 */
520 Description?: Description;
521 /**
522 * Total amount of time the deployment lasted.
523 */
524 DeploymentDurationInMinutes?: MinutesBetween0And24Hours;
525 /**
526 * The algorithm used to define how percentage grew over time.
527 */
528 GrowthType?: GrowthType;
529 /**
530 * The percentage of targets to receive a deployed configuration during each interval.
531 */
532 GrowthFactor?: Percentage;
533 /**
534 * The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
535 */
536 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours;
537 /**
538 * The state of the deployment.
539 */
540 State?: DeploymentState;
541 /**
542 * A list containing all events related to a deployment. The most recent events are displayed first.
543 */
544 EventLog?: DeploymentEvents;
545 /**
546 * The percentage of targets for which the deployment is available.
547 */
548 PercentageComplete?: Percentage;
549 /**
550 * The time the deployment started.
551 */
552 StartedAt?: Iso8601DateTime;
553 /**
554 * The time the deployment completed.
555 */
556 CompletedAt?: Iso8601DateTime;
557 }
558 export interface DeploymentEvent {
559 /**
560 * The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.
561 */
562 EventType?: DeploymentEventType;
563 /**
564 * The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
565 */
566 TriggeredBy?: TriggeredBy;
567 /**
568 * A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.
569 */
570 Description?: Description;
571 /**
572 * The date and time the event occurred.
573 */
574 OccurredAt?: Iso8601DateTime;
575 }
576 export type DeploymentEventType = "PERCENTAGE_UPDATED"|"ROLLBACK_STARTED"|"ROLLBACK_COMPLETED"|"BAKE_TIME_STARTED"|"DEPLOYMENT_STARTED"|"DEPLOYMENT_COMPLETED"|string;
577 export type DeploymentEvents = DeploymentEvent[];
578 export type DeploymentList = DeploymentSummary[];
579 export type DeploymentState = "BAKING"|"VALIDATING"|"DEPLOYING"|"COMPLETE"|"ROLLING_BACK"|"ROLLED_BACK"|string;
580 export interface DeploymentStrategies {
581 /**
582 * The elements from this collection.
583 */
584 Items?: DeploymentStrategyList;
585 /**
586 * The token for the next set of items to return. Use this token to get the next set of results.
587 */
588 NextToken?: NextToken;
589 }
590 export interface DeploymentStrategy {
591 /**
592 * The deployment strategy ID.
593 */
594 Id?: Id;
595 /**
596 * The name of the deployment strategy.
597 */
598 Name?: Name;
599 /**
600 * The description of the deployment strategy.
601 */
602 Description?: Description;
603 /**
604 * Total amount of time the deployment lasted.
605 */
606 DeploymentDurationInMinutes?: MinutesBetween0And24Hours;
607 /**
608 * The algorithm used to define how percentage grew over time.
609 */
610 GrowthType?: GrowthType;
611 /**
612 * The percentage of targets that received a deployed configuration during each interval.
613 */
614 GrowthFactor?: Percentage;
615 /**
616 * The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
617 */
618 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours;
619 /**
620 * Save the deployment strategy to a Systems Manager (SSM) document.
621 */
622 ReplicateTo?: ReplicateTo;
623 }
624 export type DeploymentStrategyId = string;
625 export type DeploymentStrategyList = DeploymentStrategy[];
626 export interface DeploymentSummary {
627 /**
628 * The sequence number of the deployment.
629 */
630 DeploymentNumber?: Integer;
631 /**
632 * The name of the configuration.
633 */
634 ConfigurationName?: Name;
635 /**
636 * The version of the configuration.
637 */
638 ConfigurationVersion?: Version;
639 /**
640 * Total amount of time the deployment lasted.
641 */
642 DeploymentDurationInMinutes?: MinutesBetween0And24Hours;
643 /**
644 * The algorithm used to define how percentage grows over time.
645 */
646 GrowthType?: GrowthType;
647 /**
648 * The percentage of targets to receive a deployed configuration during each interval.
649 */
650 GrowthFactor?: Percentage;
651 /**
652 * The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
653 */
654 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours;
655 /**
656 * The state of the deployment.
657 */
658 State?: DeploymentState;
659 /**
660 * The percentage of targets for which the deployment is available.
661 */
662 PercentageComplete?: Percentage;
663 /**
664 * Time the deployment started.
665 */
666 StartedAt?: Iso8601DateTime;
667 /**
668 * Time the deployment completed.
669 */
670 CompletedAt?: Iso8601DateTime;
671 }
672 export interface Deployments {
673 /**
674 * The elements from this collection.
675 */
676 Items?: DeploymentList;
677 /**
678 * The token for the next set of items to return. Use this token to get the next set of results.
679 */
680 NextToken?: NextToken;
681 }
682 export type Description = string;
683 export interface Environment {
684 /**
685 * The application ID.
686 */
687 ApplicationId?: Id;
688 /**
689 * The environment ID.
690 */
691 Id?: Id;
692 /**
693 * The name of the environment.
694 */
695 Name?: Name;
696 /**
697 * The description of the environment.
698 */
699 Description?: Description;
700 /**
701 * The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
702 */
703 State?: EnvironmentState;
704 /**
705 * Amazon CloudWatch alarms monitored during the deployment.
706 */
707 Monitors?: MonitorList;
708 }
709 export type EnvironmentList = Environment[];
710 export type EnvironmentState = "READY_FOR_DEPLOYMENT"|"DEPLOYING"|"ROLLING_BACK"|"ROLLED_BACK"|string;
711 export interface Environments {
712 /**
713 * The elements from this collection.
714 */
715 Items?: EnvironmentList;
716 /**
717 * The token for the next set of items to return. Use this token to get the next set of results.
718 */
719 NextToken?: NextToken;
720 }
721 export interface GetApplicationRequest {
722 /**
723 * The ID of the application you want to get.
724 */
725 ApplicationId: Id;
726 }
727 export interface GetConfigurationProfileRequest {
728 /**
729 * The ID of the application that includes the configuration profile you want to get.
730 */
731 ApplicationId: Id;
732 /**
733 * The ID of the configuration profile you want to get.
734 */
735 ConfigurationProfileId: Id;
736 }
737 export interface GetConfigurationRequest {
738 /**
739 * The application to get. Specify either the application name or the application ID.
740 */
741 Application: StringWithLengthBetween1And64;
742 /**
743 * The environment to get. Specify either the environment name or the environment ID.
744 */
745 Environment: StringWithLengthBetween1And64;
746 /**
747 * The configuration to get. Specify either the configuration name or the configuration ID.
748 */
749 Configuration: StringWithLengthBetween1And64;
750 /**
751 * A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
752 */
753 ClientId: StringWithLengthBetween1And64;
754 /**
755 * The configuration version returned in the most recent GetConfiguration response.
756 */
757 ClientConfigurationVersion?: Version;
758 }
759 export interface GetDeploymentRequest {
760 /**
761 * The ID of the application that includes the deployment you want to get.
762 */
763 ApplicationId: Id;
764 /**
765 * The ID of the environment that includes the deployment you want to get.
766 */
767 EnvironmentId: Id;
768 /**
769 * The sequence number of the deployment.
770 */
771 DeploymentNumber: Integer;
772 }
773 export interface GetDeploymentStrategyRequest {
774 /**
775 * The ID of the deployment strategy to get.
776 */
777 DeploymentStrategyId: DeploymentStrategyId;
778 }
779 export interface GetEnvironmentRequest {
780 /**
781 * The ID of the application that includes the environment you want to get.
782 */
783 ApplicationId: Id;
784 /**
785 * The ID of the environment you wnat to get.
786 */
787 EnvironmentId: Id;
788 }
789 export type GrowthFactor = number;
790 export type GrowthType = "LINEAR"|"EXPONENTIAL"|string;
791 export type Id = string;
792 export type Integer = number;
793 export type Iso8601DateTime = Date;
794 export interface ListApplicationsRequest {
795 /**
796 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
797 */
798 MaxResults?: MaxResults;
799 /**
800 * A token to start the list. Use this token to get the next set of results.
801 */
802 NextToken?: NextToken;
803 }
804 export interface ListConfigurationProfilesRequest {
805 /**
806 * The application ID.
807 */
808 ApplicationId: Id;
809 /**
810 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
811 */
812 MaxResults?: MaxResults;
813 /**
814 * A token to start the list. Use this token to get the next set of results.
815 */
816 NextToken?: NextToken;
817 }
818 export interface ListDeploymentStrategiesRequest {
819 /**
820 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
821 */
822 MaxResults?: MaxResults;
823 /**
824 * A token to start the list. Use this token to get the next set of results.
825 */
826 NextToken?: NextToken;
827 }
828 export interface ListDeploymentsRequest {
829 /**
830 * The application ID.
831 */
832 ApplicationId: Id;
833 /**
834 * The environment ID.
835 */
836 EnvironmentId: Id;
837 /**
838 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
839 */
840 MaxResults?: MaxResults;
841 /**
842 * A token to start the list. Use this token to get the next set of results.
843 */
844 NextToken?: NextToken;
845 }
846 export interface ListEnvironmentsRequest {
847 /**
848 * The application ID.
849 */
850 ApplicationId: Id;
851 /**
852 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
853 */
854 MaxResults?: MaxResults;
855 /**
856 * A token to start the list. Use this token to get the next set of results.
857 */
858 NextToken?: NextToken;
859 }
860 export interface ListTagsForResourceRequest {
861 /**
862 * The resource ARN.
863 */
864 ResourceArn: Arn;
865 }
866 export type MaxResults = number;
867 export type MinutesBetween0And24Hours = number;
868 export interface Monitor {
869 /**
870 * ARN of the Amazon CloudWatch alarm.
871 */
872 AlarmArn?: Arn;
873 /**
874 * ARN of an IAM role for AppConfig to monitor AlarmArn.
875 */
876 AlarmRoleArn?: Arn;
877 }
878 export type MonitorList = Monitor[];
879 export type Name = string;
880 export type NextToken = string;
881 export type Percentage = number;
882 export type ReplicateTo = "NONE"|"SSM_DOCUMENT"|string;
883 export interface ResourceTags {
884 /**
885 * Metadata to assign to AppConfig resources. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
886 */
887 Tags?: TagMap;
888 }
889 export interface StartDeploymentRequest {
890 /**
891 * The application ID.
892 */
893 ApplicationId: Id;
894 /**
895 * The environment ID.
896 */
897 EnvironmentId: Id;
898 /**
899 * The deployment strategy ID.
900 */
901 DeploymentStrategyId: DeploymentStrategyId;
902 /**
903 * The configuration profile ID.
904 */
905 ConfigurationProfileId: Id;
906 /**
907 * The configuration version to deploy.
908 */
909 ConfigurationVersion: Version;
910 /**
911 * A description of the deployment.
912 */
913 Description?: Description;
914 /**
915 * Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
916 */
917 Tags?: TagMap;
918 }
919 export interface StopDeploymentRequest {
920 /**
921 * The application ID.
922 */
923 ApplicationId: Id;
924 /**
925 * The environment ID.
926 */
927 EnvironmentId: Id;
928 /**
929 * The sequence number of the deployment.
930 */
931 DeploymentNumber: Integer;
932 }
933 export type String = string;
934 export type StringWithLengthBetween0And32768 = string;
935 export type StringWithLengthBetween1And64 = string;
936 export type TagKey = string;
937 export type TagKeyList = TagKey[];
938 export type TagMap = {[key: string]: TagValue};
939 export interface TagResourceRequest {
940 /**
941 * The ARN of the resource for which to retrieve tags.
942 */
943 ResourceArn: Arn;
944 /**
945 * The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
946 */
947 Tags: TagMap;
948 }
949 export type TagValue = string;
950 export type TriggeredBy = "USER"|"APPCONFIG"|"CLOUDWATCH_ALARM"|"INTERNAL_ERROR"|string;
951 export interface UntagResourceRequest {
952 /**
953 * The ARN of the resource for which to remove tags.
954 */
955 ResourceArn: Arn;
956 /**
957 * The tag keys to delete.
958 */
959 TagKeys: TagKeyList;
960 }
961 export interface UpdateApplicationRequest {
962 /**
963 * The application ID.
964 */
965 ApplicationId: Id;
966 /**
967 * The name of the application.
968 */
969 Name?: Name;
970 /**
971 * A description of the application.
972 */
973 Description?: Description;
974 }
975 export interface UpdateConfigurationProfileRequest {
976 /**
977 * The application ID.
978 */
979 ApplicationId: Id;
980 /**
981 * The ID of the configuration profile.
982 */
983 ConfigurationProfileId: Id;
984 /**
985 * The name of the configuration profile.
986 */
987 Name?: Name;
988 /**
989 * A description of the configuration profile.
990 */
991 Description?: Description;
992 /**
993 * The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
994 */
995 RetrievalRoleArn?: Arn;
996 /**
997 * A list of methods for validating the configuration.
998 */
999 Validators?: ValidatorList;
1000 }
1001 export interface UpdateDeploymentStrategyRequest {
1002 /**
1003 * The deployment strategy ID.
1004 */
1005 DeploymentStrategyId: DeploymentStrategyId;
1006 /**
1007 * A description of the deployment strategy.
1008 */
1009 Description?: Description;
1010 /**
1011 * Total amount of time for a deployment to last.
1012 */
1013 DeploymentDurationInMinutes?: MinutesBetween0And24Hours;
1014 /**
1015 * The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
1016 */
1017 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours;
1018 /**
1019 * The percentage of targets to receive a deployed configuration during each interval.
1020 */
1021 GrowthFactor?: GrowthFactor;
1022 /**
1023 * The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration. Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: 2*(2^0) 2*(2^1) 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
1024 */
1025 GrowthType?: GrowthType;
1026 }
1027 export interface UpdateEnvironmentRequest {
1028 /**
1029 * The application ID.
1030 */
1031 ApplicationId: Id;
1032 /**
1033 * The environment ID.
1034 */
1035 EnvironmentId: Id;
1036 /**
1037 * The name of the environment.
1038 */
1039 Name?: Name;
1040 /**
1041 * A description of the environment.
1042 */
1043 Description?: Description;
1044 /**
1045 * Amazon CloudWatch alarms to monitor during the deployment process.
1046 */
1047 Monitors?: MonitorList;
1048 }
1049 export type Uri = string;
1050 export interface ValidateConfigurationRequest {
1051 /**
1052 * The application ID.
1053 */
1054 ApplicationId: Id;
1055 /**
1056 * The configuration profile ID.
1057 */
1058 ConfigurationProfileId: Id;
1059 /**
1060 * The version of the configuration to validate.
1061 */
1062 ConfigurationVersion: Version;
1063 }
1064 export interface Validator {
1065 /**
1066 * AppConfig supports validators of type JSON_SCHEMA and LAMBDA
1067 */
1068 Type: ValidatorType;
1069 /**
1070 * Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function.
1071 */
1072 Content: StringWithLengthBetween0And32768;
1073 }
1074 export type ValidatorList = Validator[];
1075 export type ValidatorType = "JSON_SCHEMA"|"LAMBDA"|string;
1076 export type ValidatorTypeList = ValidatorType[];
1077 export type Version = string;
1078 /**
1079 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1080 */
1081 export type apiVersion = "2019-10-09"|"latest"|string;
1082 export interface ClientApiVersions {
1083 /**
1084 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1085 */
1086 apiVersion?: apiVersion;
1087 }
1088 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1089 /**
1090 * Contains interfaces for use with the AppConfig client.
1091 */
1092 export import Types = AppConfig;
1093}
1094export = AppConfig;