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