@aws-sdk/client-appconfig 3.379.1 → 3.382.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.
@@ -48,20 +48,24 @@ import { AppConfigServiceException as __BaseException } from "./AppConfigService
48
48
  */
49
49
  export interface Action {
50
50
  /**
51
+ * @public
51
52
  * <p>The action name.</p>
52
53
  */
53
54
  Name?: string;
54
55
  /**
56
+ * @public
55
57
  * <p>Information about the action.</p>
56
58
  */
57
59
  Description?: string;
58
60
  /**
61
+ * @public
59
62
  * <p>The extension URI associated to the action point in the extension definition. The URI
60
63
  * can be an Amazon Resource Name (ARN) for one of the following: an Lambda
61
64
  * function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.</p>
62
65
  */
63
66
  Uri?: string;
64
67
  /**
68
+ * @public
65
69
  * <p>An Amazon Resource Name (ARN) for an Identity and Access Management assume role.</p>
66
70
  */
67
71
  RoleArn?: string;
@@ -72,32 +76,39 @@ export interface Action {
72
76
  */
73
77
  export interface ActionInvocation {
74
78
  /**
79
+ * @public
75
80
  * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
76
81
  */
77
82
  ExtensionIdentifier?: string;
78
83
  /**
84
+ * @public
79
85
  * <p>The name of the action.</p>
80
86
  */
81
87
  ActionName?: string;
82
88
  /**
89
+ * @public
83
90
  * <p>The extension URI associated to the action point in the extension definition. The URI
84
91
  * can be an Amazon Resource Name (ARN) for one of the following: an Lambda
85
92
  * function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.</p>
86
93
  */
87
94
  Uri?: string;
88
95
  /**
96
+ * @public
89
97
  * <p>An Amazon Resource Name (ARN) for an Identity and Access Management assume role.</p>
90
98
  */
91
99
  RoleArn?: string;
92
100
  /**
101
+ * @public
93
102
  * <p>The error message when an extension invocation fails.</p>
94
103
  */
95
104
  ErrorMessage?: string;
96
105
  /**
106
+ * @public
97
107
  * <p>The error code when an extension invocation fails.</p>
98
108
  */
99
109
  ErrorCode?: string;
100
110
  /**
111
+ * @public
101
112
  * <p>A system-generated ID for this invocation.</p>
102
113
  */
103
114
  InvocationId?: string;
@@ -124,14 +135,17 @@ export type ActionPoint = (typeof ActionPoint)[keyof typeof ActionPoint];
124
135
  */
125
136
  export interface Application {
126
137
  /**
138
+ * @public
127
139
  * <p>The application ID.</p>
128
140
  */
129
141
  Id?: string;
130
142
  /**
143
+ * @public
131
144
  * <p>The application name.</p>
132
145
  */
133
146
  Name?: string;
134
147
  /**
148
+ * @public
135
149
  * <p>The description of the application.</p>
136
150
  */
137
151
  Description?: string;
@@ -143,24 +157,29 @@ export interface Application {
143
157
  */
144
158
  export interface InvalidConfigurationDetail {
145
159
  /**
160
+ * @public
146
161
  * <p>The invalid or out-of-range validation constraint in your JSON schema that failed
147
162
  * validation.</p>
148
163
  */
149
164
  Constraint?: string;
150
165
  /**
166
+ * @public
151
167
  * <p>Location of the validation constraint in the configuration JSON schema that failed
152
168
  * validation.</p>
153
169
  */
154
170
  Location?: string;
155
171
  /**
172
+ * @public
156
173
  * <p>The reason for an invalid configuration error.</p>
157
174
  */
158
175
  Reason?: string;
159
176
  /**
177
+ * @public
160
178
  * <p>The type of error for an invalid configuration.</p>
161
179
  */
162
180
  Type?: string;
163
181
  /**
182
+ * @public
164
183
  * <p>Details about an error with Lambda when a synchronous extension
165
184
  * experiences an error during an invocation.</p>
166
185
  */
@@ -177,6 +196,7 @@ export type BadRequestDetails = BadRequestDetails.InvalidConfigurationMember | B
177
196
  */
178
197
  export declare namespace BadRequestDetails {
179
198
  /**
199
+ * @public
180
200
  * <p>Detailed information about the bad request exception error when creating a hosted
181
201
  * configuration version.</p>
182
202
  */
@@ -184,6 +204,9 @@ export declare namespace BadRequestDetails {
184
204
  InvalidConfiguration: InvalidConfigurationDetail[];
185
205
  $unknown?: never;
186
206
  }
207
+ /**
208
+ * @public
209
+ */
187
210
  interface $UnknownMember {
188
211
  InvalidConfiguration?: never;
189
212
  $unknown: [string, any];
@@ -215,6 +238,7 @@ export declare class BadRequestException extends __BaseException {
215
238
  Message?: string;
216
239
  Reason?: BadRequestReason | string;
217
240
  /**
241
+ * @public
218
242
  * <p>Detailed information about the input that failed to satisfy the constraints specified by
219
243
  * a call.</p>
220
244
  */
@@ -229,14 +253,17 @@ export declare class BadRequestException extends __BaseException {
229
253
  */
230
254
  export interface CreateApplicationRequest {
231
255
  /**
256
+ * @public
232
257
  * <p>A name for the application.</p>
233
258
  */
234
259
  Name: string | undefined;
235
260
  /**
261
+ * @public
236
262
  * <p>A description of the application.</p>
237
263
  */
238
264
  Description?: string;
239
265
  /**
266
+ * @public
240
267
  * <p>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
241
268
  * you define.</p>
242
269
  */
@@ -277,12 +304,14 @@ export type ValidatorType = (typeof ValidatorType)[keyof typeof ValidatorType];
277
304
  */
278
305
  export interface Validator {
279
306
  /**
307
+ * @public
280
308
  * <p>AppConfig supports validators of type <code>JSON_SCHEMA</code> and
281
309
  * <code>LAMBDA</code>
282
310
  * </p>
283
311
  */
284
312
  Type: ValidatorType | string | undefined;
285
313
  /**
314
+ * @public
286
315
  * <p>Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda
287
316
  * function.</p>
288
317
  */
@@ -293,35 +322,43 @@ export interface Validator {
293
322
  */
294
323
  export interface ConfigurationProfile {
295
324
  /**
325
+ * @public
296
326
  * <p>The application ID.</p>
297
327
  */
298
328
  ApplicationId?: string;
299
329
  /**
330
+ * @public
300
331
  * <p>The configuration profile ID.</p>
301
332
  */
302
333
  Id?: string;
303
334
  /**
335
+ * @public
304
336
  * <p>The name of the configuration profile.</p>
305
337
  */
306
338
  Name?: string;
307
339
  /**
340
+ * @public
308
341
  * <p>The configuration profile description.</p>
309
342
  */
310
343
  Description?: string;
311
344
  /**
345
+ * @public
312
346
  * <p>The URI location of the configuration.</p>
313
347
  */
314
348
  LocationUri?: string;
315
349
  /**
350
+ * @public
316
351
  * <p>The ARN of an IAM role with permission to access the configuration at the specified
317
352
  * <code>LocationUri</code>.</p>
318
353
  */
319
354
  RetrievalRoleArn?: string;
320
355
  /**
356
+ * @public
321
357
  * <p>A list of methods for validating the configuration.</p>
322
358
  */
323
359
  Validators?: Validator[];
324
360
  /**
361
+ * @public
325
362
  * <p>The type of configurations contained in the profile. AppConfig supports
326
363
  * <code>feature flags</code> and <code>freeform</code> configurations. We recommend you
327
364
  * create feature flag configurations to enable or disable new features and freeform
@@ -341,18 +378,22 @@ export interface ConfigurationProfile {
341
378
  */
342
379
  export interface CreateConfigurationProfileRequest {
343
380
  /**
381
+ * @public
344
382
  * <p>The application ID.</p>
345
383
  */
346
384
  ApplicationId: string | undefined;
347
385
  /**
386
+ * @public
348
387
  * <p>A name for the configuration profile.</p>
349
388
  */
350
389
  Name: string | undefined;
351
390
  /**
391
+ * @public
352
392
  * <p>A description of the configuration profile.</p>
353
393
  */
354
394
  Description?: string;
355
395
  /**
396
+ * @public
356
397
  * <p>A URI to locate the configuration. You can specify the following:</p>
357
398
  * <ul>
358
399
  * <li>
@@ -382,6 +423,7 @@ export interface CreateConfigurationProfileRequest {
382
423
  */
383
424
  LocationUri: string | undefined;
384
425
  /**
426
+ * @public
385
427
  * <p>The ARN of an IAM role with permission to access the configuration at the specified
386
428
  * <code>LocationUri</code>.</p>
387
429
  * <important>
@@ -391,16 +433,19 @@ export interface CreateConfigurationProfileRequest {
391
433
  */
392
434
  RetrievalRoleArn?: string;
393
435
  /**
436
+ * @public
394
437
  * <p>A list of methods for validating the configuration.</p>
395
438
  */
396
439
  Validators?: Validator[];
397
440
  /**
441
+ * @public
398
442
  * <p>Metadata to assign to the configuration profile. Tags help organize and categorize your
399
443
  * AppConfig resources. Each tag consists of a key and an optional value, both of
400
444
  * which you define.</p>
401
445
  */
402
446
  Tags?: Record<string, string>;
403
447
  /**
448
+ * @public
404
449
  * <p>The type of configurations contained in the profile. AppConfig supports
405
450
  * <code>feature flags</code> and <code>freeform</code> configurations. We recommend you
406
451
  * create feature flag configurations to enable or disable new features and freeform
@@ -458,18 +503,22 @@ export type ReplicateTo = (typeof ReplicateTo)[keyof typeof ReplicateTo];
458
503
  */
459
504
  export interface CreateDeploymentStrategyRequest {
460
505
  /**
506
+ * @public
461
507
  * <p>A name for the deployment strategy.</p>
462
508
  */
463
509
  Name: string | undefined;
464
510
  /**
511
+ * @public
465
512
  * <p>A description of the deployment strategy.</p>
466
513
  */
467
514
  Description?: string;
468
515
  /**
516
+ * @public
469
517
  * <p>Total amount of time for a deployment to last.</p>
470
518
  */
471
519
  DeploymentDurationInMinutes: number | undefined;
472
520
  /**
521
+ * @public
473
522
  * <p>Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the
474
523
  * configuration has been deployed to 100% of its targets, before considering the deployment
475
524
  * to be complete. If an alarm is triggered during this time, AppConfig rolls back
@@ -479,11 +528,13 @@ export interface CreateDeploymentStrategyRequest {
479
528
  */
480
529
  FinalBakeTimeInMinutes?: number;
481
530
  /**
531
+ * @public
482
532
  * <p>The percentage of targets to receive a deployed configuration during each
483
533
  * interval.</p>
484
534
  */
485
535
  GrowthFactor: number | undefined;
486
536
  /**
537
+ * @public
487
538
  * <p>The algorithm used to define how percentage grows over time. AppConfig
488
539
  * supports the following growth types:</p>
489
540
  * <p>
@@ -516,10 +567,12 @@ export interface CreateDeploymentStrategyRequest {
516
567
  */
517
568
  GrowthType?: GrowthType | string;
518
569
  /**
570
+ * @public
519
571
  * <p>Save the deployment strategy to a Systems Manager (SSM) document.</p>
520
572
  */
521
573
  ReplicateTo?: ReplicateTo | string;
522
574
  /**
575
+ * @public
523
576
  * <p>Metadata to assign to the deployment strategy. Tags help organize and categorize your
524
577
  * AppConfig resources. Each tag consists of a key and an optional value, both of
525
578
  * which you define.</p>
@@ -531,36 +584,44 @@ export interface CreateDeploymentStrategyRequest {
531
584
  */
532
585
  export interface DeploymentStrategy {
533
586
  /**
587
+ * @public
534
588
  * <p>The deployment strategy ID.</p>
535
589
  */
536
590
  Id?: string;
537
591
  /**
592
+ * @public
538
593
  * <p>The name of the deployment strategy.</p>
539
594
  */
540
595
  Name?: string;
541
596
  /**
597
+ * @public
542
598
  * <p>The description of the deployment strategy.</p>
543
599
  */
544
600
  Description?: string;
545
601
  /**
602
+ * @public
546
603
  * <p>Total amount of time the deployment lasted.</p>
547
604
  */
548
605
  DeploymentDurationInMinutes?: number;
549
606
  /**
607
+ * @public
550
608
  * <p>The algorithm used to define how percentage grew over time.</p>
551
609
  */
552
610
  GrowthType?: GrowthType | string;
553
611
  /**
612
+ * @public
554
613
  * <p>The percentage of targets that received a deployed configuration during each
555
614
  * interval.</p>
556
615
  */
557
616
  GrowthFactor?: number;
558
617
  /**
618
+ * @public
559
619
  * <p>The amount of time that AppConfig monitored for alarms before considering the
560
620
  * deployment to be complete and no longer eligible for automatic rollback.</p>
561
621
  */
562
622
  FinalBakeTimeInMinutes?: number;
563
623
  /**
624
+ * @public
564
625
  * <p>Save the deployment strategy to a Systems Manager (SSM) document.</p>
565
626
  */
566
627
  ReplicateTo?: ReplicateTo | string;
@@ -571,10 +632,12 @@ export interface DeploymentStrategy {
571
632
  */
572
633
  export interface Monitor {
573
634
  /**
635
+ * @public
574
636
  * <p>Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.</p>
575
637
  */
576
638
  AlarmArn: string | undefined;
577
639
  /**
640
+ * @public
578
641
  * <p>ARN of an Identity and Access Management (IAM) role for AppConfig to monitor
579
642
  * <code>AlarmArn</code>.</p>
580
643
  */
@@ -585,22 +648,27 @@ export interface Monitor {
585
648
  */
586
649
  export interface CreateEnvironmentRequest {
587
650
  /**
651
+ * @public
588
652
  * <p>The application ID.</p>
589
653
  */
590
654
  ApplicationId: string | undefined;
591
655
  /**
656
+ * @public
592
657
  * <p>A name for the environment.</p>
593
658
  */
594
659
  Name: string | undefined;
595
660
  /**
661
+ * @public
596
662
  * <p>A description of the environment.</p>
597
663
  */
598
664
  Description?: string;
599
665
  /**
666
+ * @public
600
667
  * <p>Amazon CloudWatch alarms to monitor during the deployment process.</p>
601
668
  */
602
669
  Monitors?: Monitor[];
603
670
  /**
671
+ * @public
604
672
  * <p>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
605
673
  * you define.</p>
606
674
  */
@@ -625,22 +693,27 @@ export type EnvironmentState = (typeof EnvironmentState)[keyof typeof Environmen
625
693
  */
626
694
  export interface Environment {
627
695
  /**
696
+ * @public
628
697
  * <p>The application ID.</p>
629
698
  */
630
699
  ApplicationId?: string;
631
700
  /**
701
+ * @public
632
702
  * <p>The environment ID.</p>
633
703
  */
634
704
  Id?: string;
635
705
  /**
706
+ * @public
636
707
  * <p>The name of the environment.</p>
637
708
  */
638
709
  Name?: string;
639
710
  /**
711
+ * @public
640
712
  * <p>The description of the environment.</p>
641
713
  */
642
714
  Description?: string;
643
715
  /**
716
+ * @public
644
717
  * <p>The state of the environment. An environment can be in one of the following states:
645
718
  * <code>READY_FOR_DEPLOYMENT</code>, <code>DEPLOYING</code>, <code>ROLLING_BACK</code>, or
646
719
  * <code>ROLLED_BACK</code>
@@ -648,6 +721,7 @@ export interface Environment {
648
721
  */
649
722
  State?: EnvironmentState | string;
650
723
  /**
724
+ * @public
651
725
  * <p>Amazon CloudWatch alarms monitored during the deployment.</p>
652
726
  */
653
727
  Monitors?: Monitor[];
@@ -676,10 +750,12 @@ export declare class ConflictException extends __BaseException {
676
750
  */
677
751
  export interface Parameter {
678
752
  /**
753
+ * @public
679
754
  * <p>Information about the parameter.</p>
680
755
  */
681
756
  Description?: string;
682
757
  /**
758
+ * @public
683
759
  * <p>A parameter value must be specified in the extension association.</p>
684
760
  */
685
761
  Required?: boolean;
@@ -689,19 +765,23 @@ export interface Parameter {
689
765
  */
690
766
  export interface CreateExtensionRequest {
691
767
  /**
768
+ * @public
692
769
  * <p>A name for the extension. Each extension name in your account must be unique. Extension
693
770
  * versions use the same name.</p>
694
771
  */
695
772
  Name: string | undefined;
696
773
  /**
774
+ * @public
697
775
  * <p>Information about the extension.</p>
698
776
  */
699
777
  Description?: string;
700
778
  /**
779
+ * @public
701
780
  * <p>The actions defined in the extension.</p>
702
781
  */
703
782
  Actions: Record<string, Action[]> | undefined;
704
783
  /**
784
+ * @public
705
785
  * <p>The parameters accepted by the extension. You specify parameter values when you
706
786
  * associate the extension to an AppConfig resource by using the
707
787
  * <code>CreateExtensionAssociation</code> API action. For Lambda extension
@@ -709,12 +789,14 @@ export interface CreateExtensionRequest {
709
789
  */
710
790
  Parameters?: Record<string, Parameter>;
711
791
  /**
792
+ * @public
712
793
  * <p>Adds one or more tags for the specified extension. Tags are metadata that help you
713
794
  * categorize resources in different ways, for example, by purpose, owner, or environment.
714
795
  * Each tag consists of a key and an optional value, both of which you define. </p>
715
796
  */
716
797
  Tags?: Record<string, string>;
717
798
  /**
799
+ * @public
718
800
  * <p>You can omit this field when you create an extension. When you create a new version,
719
801
  * specify the most recent current version number. For example, you create version 3, enter 2
720
802
  * for this field.</p>
@@ -726,30 +808,37 @@ export interface CreateExtensionRequest {
726
808
  */
727
809
  export interface Extension {
728
810
  /**
811
+ * @public
729
812
  * <p>The system-generated ID of the extension.</p>
730
813
  */
731
814
  Id?: string;
732
815
  /**
816
+ * @public
733
817
  * <p>The extension name.</p>
734
818
  */
735
819
  Name?: string;
736
820
  /**
821
+ * @public
737
822
  * <p>The extension version number.</p>
738
823
  */
739
824
  VersionNumber?: number;
740
825
  /**
826
+ * @public
741
827
  * <p>The system-generated Amazon Resource Name (ARN) for the extension.</p>
742
828
  */
743
829
  Arn?: string;
744
830
  /**
831
+ * @public
745
832
  * <p>Information about the extension.</p>
746
833
  */
747
834
  Description?: string;
748
835
  /**
836
+ * @public
749
837
  * <p>The actions defined in the extension.</p>
750
838
  */
751
839
  Actions?: Record<string, Action[]>;
752
840
  /**
841
+ * @public
753
842
  * <p>The parameters accepted by the extension. You specify parameter values when you
754
843
  * associate the extension to an AppConfig resource by using the
755
844
  * <code>CreateExtensionAssociation</code> API action. For Lambda extension
@@ -775,24 +864,29 @@ export declare class ServiceQuotaExceededException extends __BaseException {
775
864
  */
776
865
  export interface CreateExtensionAssociationRequest {
777
866
  /**
867
+ * @public
778
868
  * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
779
869
  */
780
870
  ExtensionIdentifier: string | undefined;
781
871
  /**
872
+ * @public
782
873
  * <p>The version number of the extension. If not specified, AppConfig uses the
783
874
  * maximum version of the extension.</p>
784
875
  */
785
876
  ExtensionVersionNumber?: number;
786
877
  /**
878
+ * @public
787
879
  * <p>The ARN of an application, configuration profile, or environment.</p>
788
880
  */
789
881
  ResourceIdentifier: string | undefined;
790
882
  /**
883
+ * @public
791
884
  * <p>The parameter names and values defined in the extensions. Extension parameters marked
792
885
  * <code>Required</code> must be entered for this field.</p>
793
886
  */
794
887
  Parameters?: Record<string, string>;
795
888
  /**
889
+ * @public
796
890
  * <p>Adds one or more tags for the specified extension association. Tags are metadata that
797
891
  * help you categorize resources in different ways, for example, by purpose, owner, or
798
892
  * environment. Each tag consists of a key and an optional value, both of which you define.
@@ -805,27 +899,33 @@ export interface CreateExtensionAssociationRequest {
805
899
  */
806
900
  export interface ExtensionAssociation {
807
901
  /**
902
+ * @public
808
903
  * <p>The system-generated ID for the association.</p>
809
904
  */
810
905
  Id?: string;
811
906
  /**
907
+ * @public
812
908
  * <p>The ARN of the extension defined in the association.</p>
813
909
  */
814
910
  ExtensionArn?: string;
815
911
  /**
912
+ * @public
816
913
  * <p>The ARNs of applications, configuration profiles, or environments defined in the
817
914
  * association.</p>
818
915
  */
819
916
  ResourceArn?: string;
820
917
  /**
918
+ * @public
821
919
  * <p>The system-generated Amazon Resource Name (ARN) for the extension.</p>
822
920
  */
823
921
  Arn?: string;
824
922
  /**
923
+ * @public
825
924
  * <p>The parameter names and values defined in the association.</p>
826
925
  */
827
926
  Parameters?: Record<string, string>;
828
927
  /**
928
+ * @public
829
929
  * <p>The version number for the extension defined in the association.</p>
830
930
  */
831
931
  ExtensionVersionNumber?: number;
@@ -835,27 +935,33 @@ export interface ExtensionAssociation {
835
935
  */
836
936
  export interface CreateHostedConfigurationVersionRequest {
837
937
  /**
938
+ * @public
838
939
  * <p>The application ID.</p>
839
940
  */
840
941
  ApplicationId: string | undefined;
841
942
  /**
943
+ * @public
842
944
  * <p>The configuration profile ID.</p>
843
945
  */
844
946
  ConfigurationProfileId: string | undefined;
845
947
  /**
948
+ * @public
846
949
  * <p>A description of the configuration.</p>
847
950
  */
848
951
  Description?: string;
849
952
  /**
953
+ * @public
850
954
  * <p>The content of the configuration or the configuration data.</p>
851
955
  */
852
956
  Content: Uint8Array | undefined;
853
957
  /**
958
+ * @public
854
959
  * <p>A standard MIME type describing the format of the configuration content. For more
855
960
  * information, see <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a>.</p>
856
961
  */
857
962
  ContentType: string | undefined;
858
963
  /**
964
+ * @public
859
965
  * <p>An optional locking token used to prevent race conditions from overwriting configuration
860
966
  * updates when creating a new version. To ensure your data is not overwritten when creating
861
967
  * multiple hosted configuration versions in rapid succession, specify the version number of
@@ -863,6 +969,7 @@ export interface CreateHostedConfigurationVersionRequest {
863
969
  */
864
970
  LatestVersionNumber?: number;
865
971
  /**
972
+ * @public
866
973
  * <p>An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".</p>
867
974
  */
868
975
  VersionLabel?: string;
@@ -872,31 +979,38 @@ export interface CreateHostedConfigurationVersionRequest {
872
979
  */
873
980
  export interface HostedConfigurationVersion {
874
981
  /**
982
+ * @public
875
983
  * <p>The application ID.</p>
876
984
  */
877
985
  ApplicationId?: string;
878
986
  /**
987
+ * @public
879
988
  * <p>The configuration profile ID.</p>
880
989
  */
881
990
  ConfigurationProfileId?: string;
882
991
  /**
992
+ * @public
883
993
  * <p>The configuration version.</p>
884
994
  */
885
995
  VersionNumber?: number;
886
996
  /**
997
+ * @public
887
998
  * <p>A description of the configuration.</p>
888
999
  */
889
1000
  Description?: string;
890
1001
  /**
1002
+ * @public
891
1003
  * <p>The content of the configuration or the configuration data.</p>
892
1004
  */
893
1005
  Content?: Uint8Array;
894
1006
  /**
1007
+ * @public
895
1008
  * <p>A standard MIME type describing the format of the configuration content. For more
896
1009
  * information, see <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a>.</p>
897
1010
  */
898
1011
  ContentType?: string;
899
1012
  /**
1013
+ * @public
900
1014
  * <p>A user-defined label for an AppConfig hosted configuration version.</p>
901
1015
  */
902
1016
  VersionLabel?: string;
@@ -933,6 +1047,7 @@ export declare class PayloadTooLargeException extends __BaseException {
933
1047
  */
934
1048
  export interface DeleteApplicationRequest {
935
1049
  /**
1050
+ * @public
936
1051
  * <p>The ID of the application to delete.</p>
937
1052
  */
938
1053
  ApplicationId: string | undefined;
@@ -942,10 +1057,12 @@ export interface DeleteApplicationRequest {
942
1057
  */
943
1058
  export interface DeleteConfigurationProfileRequest {
944
1059
  /**
1060
+ * @public
945
1061
  * <p>The application ID that includes the configuration profile you want to delete.</p>
946
1062
  */
947
1063
  ApplicationId: string | undefined;
948
1064
  /**
1065
+ * @public
949
1066
  * <p>The ID of the configuration profile you want to delete.</p>
950
1067
  */
951
1068
  ConfigurationProfileId: string | undefined;
@@ -955,6 +1072,7 @@ export interface DeleteConfigurationProfileRequest {
955
1072
  */
956
1073
  export interface DeleteDeploymentStrategyRequest {
957
1074
  /**
1075
+ * @public
958
1076
  * <p>The ID of the deployment strategy you want to delete.</p>
959
1077
  */
960
1078
  DeploymentStrategyId: string | undefined;
@@ -964,10 +1082,12 @@ export interface DeleteDeploymentStrategyRequest {
964
1082
  */
965
1083
  export interface DeleteEnvironmentRequest {
966
1084
  /**
1085
+ * @public
967
1086
  * <p>The application ID that includes the environment that you want to delete.</p>
968
1087
  */
969
1088
  ApplicationId: string | undefined;
970
1089
  /**
1090
+ * @public
971
1091
  * <p>The ID of the environment that you want to delete.</p>
972
1092
  */
973
1093
  EnvironmentId: string | undefined;
@@ -977,10 +1097,12 @@ export interface DeleteEnvironmentRequest {
977
1097
  */
978
1098
  export interface DeleteExtensionRequest {
979
1099
  /**
1100
+ * @public
980
1101
  * <p>The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.</p>
981
1102
  */
982
1103
  ExtensionIdentifier: string | undefined;
983
1104
  /**
1105
+ * @public
984
1106
  * <p>A specific version of an extension to delete. If omitted, the highest version is
985
1107
  * deleted.</p>
986
1108
  */
@@ -991,6 +1113,7 @@ export interface DeleteExtensionRequest {
991
1113
  */
992
1114
  export interface DeleteExtensionAssociationRequest {
993
1115
  /**
1116
+ * @public
994
1117
  * <p>The ID of the extension association to delete.</p>
995
1118
  */
996
1119
  ExtensionAssociationId: string | undefined;
@@ -1000,14 +1123,17 @@ export interface DeleteExtensionAssociationRequest {
1000
1123
  */
1001
1124
  export interface DeleteHostedConfigurationVersionRequest {
1002
1125
  /**
1126
+ * @public
1003
1127
  * <p>The application ID.</p>
1004
1128
  */
1005
1129
  ApplicationId: string | undefined;
1006
1130
  /**
1131
+ * @public
1007
1132
  * <p>The configuration profile ID.</p>
1008
1133
  */
1009
1134
  ConfigurationProfileId: string | undefined;
1010
1135
  /**
1136
+ * @public
1011
1137
  * <p>The versions number to delete.</p>
1012
1138
  */
1013
1139
  VersionNumber: number | undefined;
@@ -1017,6 +1143,7 @@ export interface DeleteHostedConfigurationVersionRequest {
1017
1143
  */
1018
1144
  export interface GetApplicationRequest {
1019
1145
  /**
1146
+ * @public
1020
1147
  * <p>The ID of the application you want to get.</p>
1021
1148
  */
1022
1149
  ApplicationId: string | undefined;
@@ -1026,6 +1153,7 @@ export interface GetApplicationRequest {
1026
1153
  */
1027
1154
  export interface Configuration {
1028
1155
  /**
1156
+ * @public
1029
1157
  * <p>The content of the configuration or the configuration data.</p>
1030
1158
  * <important>
1031
1159
  * <p>The <code>Content</code> attribute only contains data if the system finds new or
@@ -1037,10 +1165,12 @@ export interface Configuration {
1037
1165
  */
1038
1166
  Content?: Uint8Array;
1039
1167
  /**
1168
+ * @public
1040
1169
  * <p>The configuration version.</p>
1041
1170
  */
1042
1171
  ConfigurationVersion?: string;
1043
1172
  /**
1173
+ * @public
1044
1174
  * <p>A standard MIME type describing the format of the configuration content. For more
1045
1175
  * information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a>.</p>
1046
1176
  */
@@ -1051,27 +1181,32 @@ export interface Configuration {
1051
1181
  */
1052
1182
  export interface GetConfigurationRequest {
1053
1183
  /**
1184
+ * @public
1054
1185
  * <p>The application to get. Specify either the application name or the application
1055
1186
  * ID.</p>
1056
1187
  */
1057
1188
  Application: string | undefined;
1058
1189
  /**
1190
+ * @public
1059
1191
  * <p>The environment to get. Specify either the environment name or the environment
1060
1192
  * ID.</p>
1061
1193
  */
1062
1194
  Environment: string | undefined;
1063
1195
  /**
1196
+ * @public
1064
1197
  * <p>The configuration to get. Specify either the configuration name or the configuration
1065
1198
  * ID.</p>
1066
1199
  */
1067
1200
  Configuration: string | undefined;
1068
1201
  /**
1202
+ * @public
1069
1203
  * <p>The clientId parameter in the following command is a unique, user-specified ID to
1070
1204
  * identify the client for the configuration. This ID enables AppConfig to deploy
1071
1205
  * the configuration in intervals, as defined in the deployment strategy. </p>
1072
1206
  */
1073
1207
  ClientId: string | undefined;
1074
1208
  /**
1209
+ * @public
1075
1210
  * <p>The configuration version returned in the most recent <code>GetConfiguration</code>
1076
1211
  * response.</p>
1077
1212
  * <important>
@@ -1099,11 +1234,13 @@ export interface GetConfigurationRequest {
1099
1234
  */
1100
1235
  export interface GetConfigurationProfileRequest {
1101
1236
  /**
1237
+ * @public
1102
1238
  * <p>The ID of the application that includes the configuration profile you want to
1103
1239
  * get.</p>
1104
1240
  */
1105
1241
  ApplicationId: string | undefined;
1106
1242
  /**
1243
+ * @public
1107
1244
  * <p>The ID of the configuration profile that you want to get.</p>
1108
1245
  */
1109
1246
  ConfigurationProfileId: string | undefined;
@@ -1114,18 +1251,22 @@ export interface GetConfigurationProfileRequest {
1114
1251
  */
1115
1252
  export interface AppliedExtension {
1116
1253
  /**
1254
+ * @public
1117
1255
  * <p>The system-generated ID of the extension.</p>
1118
1256
  */
1119
1257
  ExtensionId?: string;
1120
1258
  /**
1259
+ * @public
1121
1260
  * <p>The system-generated ID for the association.</p>
1122
1261
  */
1123
1262
  ExtensionAssociationId?: string;
1124
1263
  /**
1264
+ * @public
1125
1265
  * <p>The extension version number.</p>
1126
1266
  */
1127
1267
  VersionNumber?: number;
1128
1268
  /**
1269
+ * @public
1129
1270
  * <p>One or more parameters for the actions called by the extension.</p>
1130
1271
  */
1131
1272
  Parameters?: Record<string, string>;
@@ -1166,17 +1307,20 @@ export type TriggeredBy = (typeof TriggeredBy)[keyof typeof TriggeredBy];
1166
1307
  */
1167
1308
  export interface DeploymentEvent {
1168
1309
  /**
1310
+ * @public
1169
1311
  * <p>The type of deployment event. Deployment event types include the start, stop, or
1170
1312
  * completion of a deployment; a percentage update; the start or stop of a bake period; and
1171
1313
  * the start or completion of a rollback.</p>
1172
1314
  */
1173
1315
  EventType?: DeploymentEventType | string;
1174
1316
  /**
1317
+ * @public
1175
1318
  * <p>The entity that triggered the deployment event. Events can be triggered by a user,
1176
1319
  * AppConfig, an Amazon CloudWatch alarm, or an internal error.</p>
1177
1320
  */
1178
1321
  TriggeredBy?: TriggeredBy | string;
1179
1322
  /**
1323
+ * @public
1180
1324
  * <p>A description of the deployment event. Descriptions include, but are not limited to, the
1181
1325
  * user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts
1182
1326
  * that received the deployment, or in the case of an internal error, a recommendation to
@@ -1184,10 +1328,12 @@ export interface DeploymentEvent {
1184
1328
  */
1185
1329
  Description?: string;
1186
1330
  /**
1331
+ * @public
1187
1332
  * <p>The list of extensions that were invoked as part of the deployment.</p>
1188
1333
  */
1189
1334
  ActionInvocations?: ActionInvocation[];
1190
1335
  /**
1336
+ * @public
1191
1337
  * <p>The date and time the event occurred.</p>
1192
1338
  */
1193
1339
  OccurredAt?: Date;
@@ -1213,87 +1359,107 @@ export type DeploymentState = (typeof DeploymentState)[keyof typeof DeploymentSt
1213
1359
  */
1214
1360
  export interface Deployment {
1215
1361
  /**
1362
+ * @public
1216
1363
  * <p>The ID of the application that was deployed.</p>
1217
1364
  */
1218
1365
  ApplicationId?: string;
1219
1366
  /**
1367
+ * @public
1220
1368
  * <p>The ID of the environment that was deployed.</p>
1221
1369
  */
1222
1370
  EnvironmentId?: string;
1223
1371
  /**
1372
+ * @public
1224
1373
  * <p>The ID of the deployment strategy that was deployed.</p>
1225
1374
  */
1226
1375
  DeploymentStrategyId?: string;
1227
1376
  /**
1377
+ * @public
1228
1378
  * <p>The ID of the configuration profile that was deployed.</p>
1229
1379
  */
1230
1380
  ConfigurationProfileId?: string;
1231
1381
  /**
1382
+ * @public
1232
1383
  * <p>The sequence number of the deployment.</p>
1233
1384
  */
1234
1385
  DeploymentNumber?: number;
1235
1386
  /**
1387
+ * @public
1236
1388
  * <p>The name of the configuration.</p>
1237
1389
  */
1238
1390
  ConfigurationName?: string;
1239
1391
  /**
1392
+ * @public
1240
1393
  * <p>Information about the source location of the configuration.</p>
1241
1394
  */
1242
1395
  ConfigurationLocationUri?: string;
1243
1396
  /**
1397
+ * @public
1244
1398
  * <p>The configuration version that was deployed.</p>
1245
1399
  */
1246
1400
  ConfigurationVersion?: string;
1247
1401
  /**
1402
+ * @public
1248
1403
  * <p>The description of the deployment.</p>
1249
1404
  */
1250
1405
  Description?: string;
1251
1406
  /**
1407
+ * @public
1252
1408
  * <p>Total amount of time the deployment lasted.</p>
1253
1409
  */
1254
1410
  DeploymentDurationInMinutes?: number;
1255
1411
  /**
1412
+ * @public
1256
1413
  * <p>The algorithm used to define how percentage grew over time.</p>
1257
1414
  */
1258
1415
  GrowthType?: GrowthType | string;
1259
1416
  /**
1417
+ * @public
1260
1418
  * <p>The percentage of targets to receive a deployed configuration during each
1261
1419
  * interval.</p>
1262
1420
  */
1263
1421
  GrowthFactor?: number;
1264
1422
  /**
1423
+ * @public
1265
1424
  * <p>The amount of time that AppConfig monitored for alarms before considering the
1266
1425
  * deployment to be complete and no longer eligible for automatic rollback.</p>
1267
1426
  */
1268
1427
  FinalBakeTimeInMinutes?: number;
1269
1428
  /**
1429
+ * @public
1270
1430
  * <p>The state of the deployment.</p>
1271
1431
  */
1272
1432
  State?: DeploymentState | string;
1273
1433
  /**
1434
+ * @public
1274
1435
  * <p>A list containing all events related to a deployment. The most recent events are
1275
1436
  * displayed first.</p>
1276
1437
  */
1277
1438
  EventLog?: DeploymentEvent[];
1278
1439
  /**
1440
+ * @public
1279
1441
  * <p>The percentage of targets for which the deployment is available.</p>
1280
1442
  */
1281
1443
  PercentageComplete?: number;
1282
1444
  /**
1445
+ * @public
1283
1446
  * <p>The time the deployment started.</p>
1284
1447
  */
1285
1448
  StartedAt?: Date;
1286
1449
  /**
1450
+ * @public
1287
1451
  * <p>The time the deployment completed. </p>
1288
1452
  */
1289
1453
  CompletedAt?: Date;
1290
1454
  /**
1455
+ * @public
1291
1456
  * <p>A list of extensions that were processed as part of the deployment. The extensions that
1292
1457
  * were previously associated to the configuration profile, environment, or the application
1293
1458
  * when <code>StartDeployment</code> was called.</p>
1294
1459
  */
1295
1460
  AppliedExtensions?: AppliedExtension[];
1296
1461
  /**
1462
+ * @public
1297
1463
  * <p>The Amazon Resource Name of the Key Management Service key used to encrypt configuration
1298
1464
  * data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service
1299
1465
  * (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager
@@ -1301,6 +1467,7 @@ export interface Deployment {
1301
1467
  */
1302
1468
  KmsKeyArn?: string;
1303
1469
  /**
1470
+ * @public
1304
1471
  * <p>The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key. </p>
1305
1472
  */
1306
1473
  KmsKeyIdentifier?: string;
@@ -1310,14 +1477,17 @@ export interface Deployment {
1310
1477
  */
1311
1478
  export interface GetDeploymentRequest {
1312
1479
  /**
1480
+ * @public
1313
1481
  * <p>The ID of the application that includes the deployment you want to get. </p>
1314
1482
  */
1315
1483
  ApplicationId: string | undefined;
1316
1484
  /**
1485
+ * @public
1317
1486
  * <p>The ID of the environment that includes the deployment you want to get. </p>
1318
1487
  */
1319
1488
  EnvironmentId: string | undefined;
1320
1489
  /**
1490
+ * @public
1321
1491
  * <p>The sequence number of the deployment.</p>
1322
1492
  */
1323
1493
  DeploymentNumber: number | undefined;
@@ -1327,6 +1497,7 @@ export interface GetDeploymentRequest {
1327
1497
  */
1328
1498
  export interface GetDeploymentStrategyRequest {
1329
1499
  /**
1500
+ * @public
1330
1501
  * <p>The ID of the deployment strategy to get.</p>
1331
1502
  */
1332
1503
  DeploymentStrategyId: string | undefined;
@@ -1336,10 +1507,12 @@ export interface GetDeploymentStrategyRequest {
1336
1507
  */
1337
1508
  export interface GetEnvironmentRequest {
1338
1509
  /**
1510
+ * @public
1339
1511
  * <p>The ID of the application that includes the environment you want to get.</p>
1340
1512
  */
1341
1513
  ApplicationId: string | undefined;
1342
1514
  /**
1515
+ * @public
1343
1516
  * <p>The ID of the environment that you want to get.</p>
1344
1517
  */
1345
1518
  EnvironmentId: string | undefined;
@@ -1349,10 +1522,12 @@ export interface GetEnvironmentRequest {
1349
1522
  */
1350
1523
  export interface GetExtensionRequest {
1351
1524
  /**
1525
+ * @public
1352
1526
  * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
1353
1527
  */
1354
1528
  ExtensionIdentifier: string | undefined;
1355
1529
  /**
1530
+ * @public
1356
1531
  * <p>The extension version number. If no version number was defined, AppConfig uses
1357
1532
  * the highest version.</p>
1358
1533
  */
@@ -1363,6 +1538,7 @@ export interface GetExtensionRequest {
1363
1538
  */
1364
1539
  export interface GetExtensionAssociationRequest {
1365
1540
  /**
1541
+ * @public
1366
1542
  * <p>The extension association ID to get.</p>
1367
1543
  */
1368
1544
  ExtensionAssociationId: string | undefined;
@@ -1372,14 +1548,17 @@ export interface GetExtensionAssociationRequest {
1372
1548
  */
1373
1549
  export interface GetHostedConfigurationVersionRequest {
1374
1550
  /**
1551
+ * @public
1375
1552
  * <p>The application ID.</p>
1376
1553
  */
1377
1554
  ApplicationId: string | undefined;
1378
1555
  /**
1556
+ * @public
1379
1557
  * <p>The configuration profile ID.</p>
1380
1558
  */
1381
1559
  ConfigurationProfileId: string | undefined;
1382
1560
  /**
1561
+ * @public
1383
1562
  * <p>The version.</p>
1384
1563
  */
1385
1564
  VersionNumber: number | undefined;
@@ -1389,10 +1568,12 @@ export interface GetHostedConfigurationVersionRequest {
1389
1568
  */
1390
1569
  export interface Applications {
1391
1570
  /**
1571
+ * @public
1392
1572
  * <p>The elements from this collection.</p>
1393
1573
  */
1394
1574
  Items?: Application[];
1395
1575
  /**
1576
+ * @public
1396
1577
  * <p>The token for the next set of items to return. Use this token to get the next set of
1397
1578
  * results.</p>
1398
1579
  */
@@ -1403,11 +1584,13 @@ export interface Applications {
1403
1584
  */
1404
1585
  export interface ListApplicationsRequest {
1405
1586
  /**
1587
+ * @public
1406
1588
  * <p>The maximum number of items to return for this call. The call also returns a token that
1407
1589
  * you can specify in a subsequent call to get the next set of results.</p>
1408
1590
  */
1409
1591
  MaxResults?: number;
1410
1592
  /**
1593
+ * @public
1411
1594
  * <p>A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List
1412
1595
  * request, the nextToken should not be set. On subsequent calls, the nextToken parameter
1413
1596
  * should be set to the previous responses nextToken value. Use this token to get the next set
@@ -1421,26 +1604,32 @@ export interface ListApplicationsRequest {
1421
1604
  */
1422
1605
  export interface ConfigurationProfileSummary {
1423
1606
  /**
1607
+ * @public
1424
1608
  * <p>The application ID.</p>
1425
1609
  */
1426
1610
  ApplicationId?: string;
1427
1611
  /**
1612
+ * @public
1428
1613
  * <p>The ID of the configuration profile.</p>
1429
1614
  */
1430
1615
  Id?: string;
1431
1616
  /**
1617
+ * @public
1432
1618
  * <p>The name of the configuration profile.</p>
1433
1619
  */
1434
1620
  Name?: string;
1435
1621
  /**
1622
+ * @public
1436
1623
  * <p>The URI location of the configuration.</p>
1437
1624
  */
1438
1625
  LocationUri?: string;
1439
1626
  /**
1627
+ * @public
1440
1628
  * <p>The types of validators in the configuration profile.</p>
1441
1629
  */
1442
1630
  ValidatorTypes?: (ValidatorType | string)[];
1443
1631
  /**
1632
+ * @public
1444
1633
  * <p>The type of configurations contained in the profile. AppConfig supports
1445
1634
  * <code>feature flags</code> and <code>freeform</code> configurations. We recommend you
1446
1635
  * create feature flag configurations to enable or disable new features and freeform
@@ -1460,10 +1649,12 @@ export interface ConfigurationProfileSummary {
1460
1649
  */
1461
1650
  export interface ConfigurationProfiles {
1462
1651
  /**
1652
+ * @public
1463
1653
  * <p>The elements from this collection.</p>
1464
1654
  */
1465
1655
  Items?: ConfigurationProfileSummary[];
1466
1656
  /**
1657
+ * @public
1467
1658
  * <p>The token for the next set of items to return. Use this token to get the next set of
1468
1659
  * results.</p>
1469
1660
  */
@@ -1474,19 +1665,23 @@ export interface ConfigurationProfiles {
1474
1665
  */
1475
1666
  export interface ListConfigurationProfilesRequest {
1476
1667
  /**
1668
+ * @public
1477
1669
  * <p>The application ID.</p>
1478
1670
  */
1479
1671
  ApplicationId: string | undefined;
1480
1672
  /**
1673
+ * @public
1481
1674
  * <p>The maximum number of items to return for this call. The call also returns a token that
1482
1675
  * you can specify in a subsequent call to get the next set of results.</p>
1483
1676
  */
1484
1677
  MaxResults?: number;
1485
1678
  /**
1679
+ * @public
1486
1680
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1487
1681
  */
1488
1682
  NextToken?: string;
1489
1683
  /**
1684
+ * @public
1490
1685
  * <p>A filter based on the type of configurations that the configuration profile contains. A
1491
1686
  * configuration can be a feature flag or a freeform configuration.</p>
1492
1687
  */
@@ -1498,48 +1693,59 @@ export interface ListConfigurationProfilesRequest {
1498
1693
  */
1499
1694
  export interface DeploymentSummary {
1500
1695
  /**
1696
+ * @public
1501
1697
  * <p>The sequence number of the deployment.</p>
1502
1698
  */
1503
1699
  DeploymentNumber?: number;
1504
1700
  /**
1701
+ * @public
1505
1702
  * <p>The name of the configuration.</p>
1506
1703
  */
1507
1704
  ConfigurationName?: string;
1508
1705
  /**
1706
+ * @public
1509
1707
  * <p>The version of the configuration.</p>
1510
1708
  */
1511
1709
  ConfigurationVersion?: string;
1512
1710
  /**
1711
+ * @public
1513
1712
  * <p>Total amount of time the deployment lasted.</p>
1514
1713
  */
1515
1714
  DeploymentDurationInMinutes?: number;
1516
1715
  /**
1716
+ * @public
1517
1717
  * <p>The algorithm used to define how percentage grows over time.</p>
1518
1718
  */
1519
1719
  GrowthType?: GrowthType | string;
1520
1720
  /**
1721
+ * @public
1521
1722
  * <p>The percentage of targets to receive a deployed configuration during each
1522
1723
  * interval.</p>
1523
1724
  */
1524
1725
  GrowthFactor?: number;
1525
1726
  /**
1727
+ * @public
1526
1728
  * <p>The amount of time that AppConfig monitors for alarms before considering the
1527
1729
  * deployment to be complete and no longer eligible for automatic rollback.</p>
1528
1730
  */
1529
1731
  FinalBakeTimeInMinutes?: number;
1530
1732
  /**
1733
+ * @public
1531
1734
  * <p>The state of the deployment.</p>
1532
1735
  */
1533
1736
  State?: DeploymentState | string;
1534
1737
  /**
1738
+ * @public
1535
1739
  * <p>The percentage of targets for which the deployment is available.</p>
1536
1740
  */
1537
1741
  PercentageComplete?: number;
1538
1742
  /**
1743
+ * @public
1539
1744
  * <p>Time the deployment started.</p>
1540
1745
  */
1541
1746
  StartedAt?: Date;
1542
1747
  /**
1748
+ * @public
1543
1749
  * <p>Time the deployment completed.</p>
1544
1750
  */
1545
1751
  CompletedAt?: Date;
@@ -1549,10 +1755,12 @@ export interface DeploymentSummary {
1549
1755
  */
1550
1756
  export interface Deployments {
1551
1757
  /**
1758
+ * @public
1552
1759
  * <p>The elements from this collection.</p>
1553
1760
  */
1554
1761
  Items?: DeploymentSummary[];
1555
1762
  /**
1763
+ * @public
1556
1764
  * <p>The token for the next set of items to return. Use this token to get the next set of
1557
1765
  * results.</p>
1558
1766
  */
@@ -1563,20 +1771,24 @@ export interface Deployments {
1563
1771
  */
1564
1772
  export interface ListDeploymentsRequest {
1565
1773
  /**
1774
+ * @public
1566
1775
  * <p>The application ID.</p>
1567
1776
  */
1568
1777
  ApplicationId: string | undefined;
1569
1778
  /**
1779
+ * @public
1570
1780
  * <p>The environment ID.</p>
1571
1781
  */
1572
1782
  EnvironmentId: string | undefined;
1573
1783
  /**
1784
+ * @public
1574
1785
  * <p>The maximum number of items that may be returned for this call. If there are items that
1575
1786
  * have not yet been returned, the response will include a non-null <code>NextToken</code>
1576
1787
  * that you can provide in a subsequent call to get the next set of results.</p>
1577
1788
  */
1578
1789
  MaxResults?: number;
1579
1790
  /**
1791
+ * @public
1580
1792
  * <p>The token returned by a prior call to this operation indicating the next set of results
1581
1793
  * to be returned. If not specified, the operation will return the first set of
1582
1794
  * results.</p>
@@ -1588,10 +1800,12 @@ export interface ListDeploymentsRequest {
1588
1800
  */
1589
1801
  export interface DeploymentStrategies {
1590
1802
  /**
1803
+ * @public
1591
1804
  * <p>The elements from this collection.</p>
1592
1805
  */
1593
1806
  Items?: DeploymentStrategy[];
1594
1807
  /**
1808
+ * @public
1595
1809
  * <p>The token for the next set of items to return. Use this token to get the next set of
1596
1810
  * results.</p>
1597
1811
  */
@@ -1602,11 +1816,13 @@ export interface DeploymentStrategies {
1602
1816
  */
1603
1817
  export interface ListDeploymentStrategiesRequest {
1604
1818
  /**
1819
+ * @public
1605
1820
  * <p>The maximum number of items to return for this call. The call also returns a token that
1606
1821
  * you can specify in a subsequent call to get the next set of results.</p>
1607
1822
  */
1608
1823
  MaxResults?: number;
1609
1824
  /**
1825
+ * @public
1610
1826
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1611
1827
  */
1612
1828
  NextToken?: string;
@@ -1616,10 +1832,12 @@ export interface ListDeploymentStrategiesRequest {
1616
1832
  */
1617
1833
  export interface Environments {
1618
1834
  /**
1835
+ * @public
1619
1836
  * <p>The elements from this collection.</p>
1620
1837
  */
1621
1838
  Items?: Environment[];
1622
1839
  /**
1840
+ * @public
1623
1841
  * <p>The token for the next set of items to return. Use this token to get the next set of
1624
1842
  * results.</p>
1625
1843
  */
@@ -1630,15 +1848,18 @@ export interface Environments {
1630
1848
  */
1631
1849
  export interface ListEnvironmentsRequest {
1632
1850
  /**
1851
+ * @public
1633
1852
  * <p>The application ID.</p>
1634
1853
  */
1635
1854
  ApplicationId: string | undefined;
1636
1855
  /**
1856
+ * @public
1637
1857
  * <p>The maximum number of items to return for this call. The call also returns a token that
1638
1858
  * you can specify in a subsequent call to get the next set of results.</p>
1639
1859
  */
1640
1860
  MaxResults?: number;
1641
1861
  /**
1862
+ * @public
1642
1863
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1643
1864
  */
1644
1865
  NextToken?: string;
@@ -1652,16 +1873,19 @@ export interface ListEnvironmentsRequest {
1652
1873
  */
1653
1874
  export interface ExtensionAssociationSummary {
1654
1875
  /**
1876
+ * @public
1655
1877
  * <p>The extension association ID. This ID is used to call other
1656
1878
  * <code>ExtensionAssociation</code> API actions such as
1657
1879
  * <code>GetExtensionAssociation</code> or <code>DeleteExtensionAssociation</code>.</p>
1658
1880
  */
1659
1881
  Id?: string;
1660
1882
  /**
1883
+ * @public
1661
1884
  * <p>The system-generated Amazon Resource Name (ARN) for the extension.</p>
1662
1885
  */
1663
1886
  ExtensionArn?: string;
1664
1887
  /**
1888
+ * @public
1665
1889
  * <p>The ARNs of applications, configuration profiles, or environments defined in the
1666
1890
  * association.</p>
1667
1891
  */
@@ -1672,11 +1896,13 @@ export interface ExtensionAssociationSummary {
1672
1896
  */
1673
1897
  export interface ExtensionAssociations {
1674
1898
  /**
1899
+ * @public
1675
1900
  * <p>The list of extension associations. Each item represents an extension association to an
1676
1901
  * application, environment, or configuration profile. </p>
1677
1902
  */
1678
1903
  Items?: ExtensionAssociationSummary[];
1679
1904
  /**
1905
+ * @public
1680
1906
  * <p>The token for the next set of items to return. Use this token to get the next set of
1681
1907
  * results.</p>
1682
1908
  */
@@ -1687,23 +1913,28 @@ export interface ExtensionAssociations {
1687
1913
  */
1688
1914
  export interface ListExtensionAssociationsRequest {
1689
1915
  /**
1916
+ * @public
1690
1917
  * <p>The ARN of an application, configuration profile, or environment.</p>
1691
1918
  */
1692
1919
  ResourceIdentifier?: string;
1693
1920
  /**
1921
+ * @public
1694
1922
  * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
1695
1923
  */
1696
1924
  ExtensionIdentifier?: string;
1697
1925
  /**
1926
+ * @public
1698
1927
  * <p>The version number for the extension defined in the association.</p>
1699
1928
  */
1700
1929
  ExtensionVersionNumber?: number;
1701
1930
  /**
1931
+ * @public
1702
1932
  * <p>The maximum number of items to return for this call. The call also returns a token that
1703
1933
  * you can specify in a subsequent call to get the next set of results.</p>
1704
1934
  */
1705
1935
  MaxResults?: number;
1706
1936
  /**
1937
+ * @public
1707
1938
  * <p>A token to start the list. Use this token to get the next set of results or pass null to
1708
1939
  * get the first set of results. </p>
1709
1940
  */
@@ -1716,22 +1947,27 @@ export interface ListExtensionAssociationsRequest {
1716
1947
  */
1717
1948
  export interface ExtensionSummary {
1718
1949
  /**
1950
+ * @public
1719
1951
  * <p>The system-generated ID of the extension.</p>
1720
1952
  */
1721
1953
  Id?: string;
1722
1954
  /**
1955
+ * @public
1723
1956
  * <p>The extension name.</p>
1724
1957
  */
1725
1958
  Name?: string;
1726
1959
  /**
1960
+ * @public
1727
1961
  * <p>The extension version number.</p>
1728
1962
  */
1729
1963
  VersionNumber?: number;
1730
1964
  /**
1965
+ * @public
1731
1966
  * <p>The system-generated Amazon Resource Name (ARN) for the extension.</p>
1732
1967
  */
1733
1968
  Arn?: string;
1734
1969
  /**
1970
+ * @public
1735
1971
  * <p>Information about the extension.</p>
1736
1972
  */
1737
1973
  Description?: string;
@@ -1741,11 +1977,13 @@ export interface ExtensionSummary {
1741
1977
  */
1742
1978
  export interface Extensions {
1743
1979
  /**
1980
+ * @public
1744
1981
  * <p>The list of available extensions. The list includes Amazon Web Services authored and
1745
1982
  * user-created extensions.</p>
1746
1983
  */
1747
1984
  Items?: ExtensionSummary[];
1748
1985
  /**
1986
+ * @public
1749
1987
  * <p>The token for the next set of items to return. Use this token to get the next set of
1750
1988
  * results.</p>
1751
1989
  */
@@ -1756,15 +1994,18 @@ export interface Extensions {
1756
1994
  */
1757
1995
  export interface ListExtensionsRequest {
1758
1996
  /**
1997
+ * @public
1759
1998
  * <p>The maximum number of items to return for this call. The call also returns a token that
1760
1999
  * you can specify in a subsequent call to get the next set of results.</p>
1761
2000
  */
1762
2001
  MaxResults?: number;
1763
2002
  /**
2003
+ * @public
1764
2004
  * <p>A token to start the list. Use this token to get the next set of results. </p>
1765
2005
  */
1766
2006
  NextToken?: string;
1767
2007
  /**
2008
+ * @public
1768
2009
  * <p>The extension name.</p>
1769
2010
  */
1770
2011
  Name?: string;
@@ -1775,27 +2016,33 @@ export interface ListExtensionsRequest {
1775
2016
  */
1776
2017
  export interface HostedConfigurationVersionSummary {
1777
2018
  /**
2019
+ * @public
1778
2020
  * <p>The application ID.</p>
1779
2021
  */
1780
2022
  ApplicationId?: string;
1781
2023
  /**
2024
+ * @public
1782
2025
  * <p>The configuration profile ID.</p>
1783
2026
  */
1784
2027
  ConfigurationProfileId?: string;
1785
2028
  /**
2029
+ * @public
1786
2030
  * <p>The configuration version.</p>
1787
2031
  */
1788
2032
  VersionNumber?: number;
1789
2033
  /**
2034
+ * @public
1790
2035
  * <p>A description of the configuration.</p>
1791
2036
  */
1792
2037
  Description?: string;
1793
2038
  /**
2039
+ * @public
1794
2040
  * <p>A standard MIME type describing the format of the configuration content. For more
1795
2041
  * information, see <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a>.</p>
1796
2042
  */
1797
2043
  ContentType?: string;
1798
2044
  /**
2045
+ * @public
1799
2046
  * <p>A user-defined label for an AppConfig hosted configuration version.</p>
1800
2047
  */
1801
2048
  VersionLabel?: string;
@@ -1805,10 +2052,12 @@ export interface HostedConfigurationVersionSummary {
1805
2052
  */
1806
2053
  export interface HostedConfigurationVersions {
1807
2054
  /**
2055
+ * @public
1808
2056
  * <p>The elements from this collection.</p>
1809
2057
  */
1810
2058
  Items?: HostedConfigurationVersionSummary[];
1811
2059
  /**
2060
+ * @public
1812
2061
  * <p>The token for the next set of items to return. Use this token to get the next set of
1813
2062
  * results.</p>
1814
2063
  */
@@ -1819,23 +2068,28 @@ export interface HostedConfigurationVersions {
1819
2068
  */
1820
2069
  export interface ListHostedConfigurationVersionsRequest {
1821
2070
  /**
2071
+ * @public
1822
2072
  * <p>The application ID.</p>
1823
2073
  */
1824
2074
  ApplicationId: string | undefined;
1825
2075
  /**
2076
+ * @public
1826
2077
  * <p>The configuration profile ID.</p>
1827
2078
  */
1828
2079
  ConfigurationProfileId: string | undefined;
1829
2080
  /**
2081
+ * @public
1830
2082
  * <p>The maximum number of items to return for this call. The call also returns a token that
1831
2083
  * you can specify in a subsequent call to get the next set of results.</p>
1832
2084
  */
1833
2085
  MaxResults?: number;
1834
2086
  /**
2087
+ * @public
1835
2088
  * <p>A token to start the list. Use this token to get the next set of results. </p>
1836
2089
  */
1837
2090
  NextToken?: string;
1838
2091
  /**
2092
+ * @public
1839
2093
  * <p>An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.</p>
1840
2094
  */
1841
2095
  VersionLabel?: string;
@@ -1845,6 +2099,7 @@ export interface ListHostedConfigurationVersionsRequest {
1845
2099
  */
1846
2100
  export interface ListTagsForResourceRequest {
1847
2101
  /**
2102
+ * @public
1848
2103
  * <p>The resource ARN.</p>
1849
2104
  */
1850
2105
  ResourceArn: string | undefined;
@@ -1854,6 +2109,7 @@ export interface ListTagsForResourceRequest {
1854
2109
  */
1855
2110
  export interface ResourceTags {
1856
2111
  /**
2112
+ * @public
1857
2113
  * <p>Metadata to assign to AppConfig resources. Tags help organize and categorize
1858
2114
  * your AppConfig resources. Each tag consists of a key and an optional value, both
1859
2115
  * of which you define.</p>
@@ -1865,35 +2121,43 @@ export interface ResourceTags {
1865
2121
  */
1866
2122
  export interface StartDeploymentRequest {
1867
2123
  /**
2124
+ * @public
1868
2125
  * <p>The application ID.</p>
1869
2126
  */
1870
2127
  ApplicationId: string | undefined;
1871
2128
  /**
2129
+ * @public
1872
2130
  * <p>The environment ID.</p>
1873
2131
  */
1874
2132
  EnvironmentId: string | undefined;
1875
2133
  /**
2134
+ * @public
1876
2135
  * <p>The deployment strategy ID.</p>
1877
2136
  */
1878
2137
  DeploymentStrategyId: string | undefined;
1879
2138
  /**
2139
+ * @public
1880
2140
  * <p>The configuration profile ID.</p>
1881
2141
  */
1882
2142
  ConfigurationProfileId: string | undefined;
1883
2143
  /**
2144
+ * @public
1884
2145
  * <p>The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.</p>
1885
2146
  */
1886
2147
  ConfigurationVersion: string | undefined;
1887
2148
  /**
2149
+ * @public
1888
2150
  * <p>A description of the deployment.</p>
1889
2151
  */
1890
2152
  Description?: string;
1891
2153
  /**
2154
+ * @public
1892
2155
  * <p>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
1893
2156
  * you define.</p>
1894
2157
  */
1895
2158
  Tags?: Record<string, string>;
1896
2159
  /**
2160
+ * @public
1897
2161
  * <p>The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key. </p>
1898
2162
  */
1899
2163
  KmsKeyIdentifier?: string;
@@ -1903,14 +2167,17 @@ export interface StartDeploymentRequest {
1903
2167
  */
1904
2168
  export interface StopDeploymentRequest {
1905
2169
  /**
2170
+ * @public
1906
2171
  * <p>The application ID.</p>
1907
2172
  */
1908
2173
  ApplicationId: string | undefined;
1909
2174
  /**
2175
+ * @public
1910
2176
  * <p>The environment ID.</p>
1911
2177
  */
1912
2178
  EnvironmentId: string | undefined;
1913
2179
  /**
2180
+ * @public
1914
2181
  * <p>The sequence number of the deployment.</p>
1915
2182
  */
1916
2183
  DeploymentNumber: number | undefined;
@@ -1920,10 +2187,12 @@ export interface StopDeploymentRequest {
1920
2187
  */
1921
2188
  export interface TagResourceRequest {
1922
2189
  /**
2190
+ * @public
1923
2191
  * <p>The ARN of the resource for which to retrieve tags.</p>
1924
2192
  */
1925
2193
  ResourceArn: string | undefined;
1926
2194
  /**
2195
+ * @public
1927
2196
  * <p>The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be
1928
2197
  * up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to
1929
2198
  * 256 characters.</p>
@@ -1935,10 +2204,12 @@ export interface TagResourceRequest {
1935
2204
  */
1936
2205
  export interface UntagResourceRequest {
1937
2206
  /**
2207
+ * @public
1938
2208
  * <p>The ARN of the resource for which to remove tags.</p>
1939
2209
  */
1940
2210
  ResourceArn: string | undefined;
1941
2211
  /**
2212
+ * @public
1942
2213
  * <p>The tag keys to delete.</p>
1943
2214
  */
1944
2215
  TagKeys: string[] | undefined;
@@ -1948,14 +2219,17 @@ export interface UntagResourceRequest {
1948
2219
  */
1949
2220
  export interface UpdateApplicationRequest {
1950
2221
  /**
2222
+ * @public
1951
2223
  * <p>The application ID.</p>
1952
2224
  */
1953
2225
  ApplicationId: string | undefined;
1954
2226
  /**
2227
+ * @public
1955
2228
  * <p>The name of the application.</p>
1956
2229
  */
1957
2230
  Name?: string;
1958
2231
  /**
2232
+ * @public
1959
2233
  * <p>A description of the application.</p>
1960
2234
  */
1961
2235
  Description?: string;
@@ -1965,27 +2239,33 @@ export interface UpdateApplicationRequest {
1965
2239
  */
1966
2240
  export interface UpdateConfigurationProfileRequest {
1967
2241
  /**
2242
+ * @public
1968
2243
  * <p>The application ID.</p>
1969
2244
  */
1970
2245
  ApplicationId: string | undefined;
1971
2246
  /**
2247
+ * @public
1972
2248
  * <p>The ID of the configuration profile.</p>
1973
2249
  */
1974
2250
  ConfigurationProfileId: string | undefined;
1975
2251
  /**
2252
+ * @public
1976
2253
  * <p>The name of the configuration profile.</p>
1977
2254
  */
1978
2255
  Name?: string;
1979
2256
  /**
2257
+ * @public
1980
2258
  * <p>A description of the configuration profile.</p>
1981
2259
  */
1982
2260
  Description?: string;
1983
2261
  /**
2262
+ * @public
1984
2263
  * <p>The ARN of an IAM role with permission to access the configuration at the specified
1985
2264
  * <code>LocationUri</code>.</p>
1986
2265
  */
1987
2266
  RetrievalRoleArn?: string;
1988
2267
  /**
2268
+ * @public
1989
2269
  * <p>A list of methods for validating the configuration.</p>
1990
2270
  */
1991
2271
  Validators?: Validator[];
@@ -1995,28 +2275,34 @@ export interface UpdateConfigurationProfileRequest {
1995
2275
  */
1996
2276
  export interface UpdateDeploymentStrategyRequest {
1997
2277
  /**
2278
+ * @public
1998
2279
  * <p>The deployment strategy ID.</p>
1999
2280
  */
2000
2281
  DeploymentStrategyId: string | undefined;
2001
2282
  /**
2283
+ * @public
2002
2284
  * <p>A description of the deployment strategy.</p>
2003
2285
  */
2004
2286
  Description?: string;
2005
2287
  /**
2288
+ * @public
2006
2289
  * <p>Total amount of time for a deployment to last.</p>
2007
2290
  */
2008
2291
  DeploymentDurationInMinutes?: number;
2009
2292
  /**
2293
+ * @public
2010
2294
  * <p>The amount of time that AppConfig monitors for alarms before considering the
2011
2295
  * deployment to be complete and no longer eligible for automatic rollback.</p>
2012
2296
  */
2013
2297
  FinalBakeTimeInMinutes?: number;
2014
2298
  /**
2299
+ * @public
2015
2300
  * <p>The percentage of targets to receive a deployed configuration during each
2016
2301
  * interval.</p>
2017
2302
  */
2018
2303
  GrowthFactor?: number;
2019
2304
  /**
2305
+ * @public
2020
2306
  * <p>The algorithm used to define how percentage grows over time. AppConfig
2021
2307
  * supports the following growth types:</p>
2022
2308
  * <p>
@@ -2053,22 +2339,27 @@ export interface UpdateDeploymentStrategyRequest {
2053
2339
  */
2054
2340
  export interface UpdateEnvironmentRequest {
2055
2341
  /**
2342
+ * @public
2056
2343
  * <p>The application ID.</p>
2057
2344
  */
2058
2345
  ApplicationId: string | undefined;
2059
2346
  /**
2347
+ * @public
2060
2348
  * <p>The environment ID.</p>
2061
2349
  */
2062
2350
  EnvironmentId: string | undefined;
2063
2351
  /**
2352
+ * @public
2064
2353
  * <p>The name of the environment.</p>
2065
2354
  */
2066
2355
  Name?: string;
2067
2356
  /**
2357
+ * @public
2068
2358
  * <p>A description of the environment.</p>
2069
2359
  */
2070
2360
  Description?: string;
2071
2361
  /**
2362
+ * @public
2072
2363
  * <p>Amazon CloudWatch alarms to monitor during the deployment process.</p>
2073
2364
  */
2074
2365
  Monitors?: Monitor[];
@@ -2078,22 +2369,27 @@ export interface UpdateEnvironmentRequest {
2078
2369
  */
2079
2370
  export interface UpdateExtensionRequest {
2080
2371
  /**
2372
+ * @public
2081
2373
  * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
2082
2374
  */
2083
2375
  ExtensionIdentifier: string | undefined;
2084
2376
  /**
2377
+ * @public
2085
2378
  * <p>Information about the extension.</p>
2086
2379
  */
2087
2380
  Description?: string;
2088
2381
  /**
2382
+ * @public
2089
2383
  * <p>The actions defined in the extension.</p>
2090
2384
  */
2091
2385
  Actions?: Record<string, Action[]>;
2092
2386
  /**
2387
+ * @public
2093
2388
  * <p>One or more parameters for the actions called by the extension.</p>
2094
2389
  */
2095
2390
  Parameters?: Record<string, Parameter>;
2096
2391
  /**
2392
+ * @public
2097
2393
  * <p>The extension version number.</p>
2098
2394
  */
2099
2395
  VersionNumber?: number;
@@ -2103,10 +2399,12 @@ export interface UpdateExtensionRequest {
2103
2399
  */
2104
2400
  export interface UpdateExtensionAssociationRequest {
2105
2401
  /**
2402
+ * @public
2106
2403
  * <p>The system-generated ID for the association.</p>
2107
2404
  */
2108
2405
  ExtensionAssociationId: string | undefined;
2109
2406
  /**
2407
+ * @public
2110
2408
  * <p>The parameter names and values defined in the extension.</p>
2111
2409
  */
2112
2410
  Parameters?: Record<string, string>;
@@ -2116,14 +2414,17 @@ export interface UpdateExtensionAssociationRequest {
2116
2414
  */
2117
2415
  export interface ValidateConfigurationRequest {
2118
2416
  /**
2417
+ * @public
2119
2418
  * <p>The application ID.</p>
2120
2419
  */
2121
2420
  ApplicationId: string | undefined;
2122
2421
  /**
2422
+ * @public
2123
2423
  * <p>The configuration profile ID.</p>
2124
2424
  */
2125
2425
  ConfigurationProfileId: string | undefined;
2126
2426
  /**
2427
+ * @public
2127
2428
  * <p>The version of the configuration to validate.</p>
2128
2429
  */
2129
2430
  ConfigurationVersion: string | undefined;