@aws-sdk/client-codedeploy 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.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +418 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -6,10 +6,12 @@ import { CodeDeployServiceException as __BaseException } from "./CodeDeployServi
6
6
  */
7
7
  export interface Tag {
8
8
  /**
9
+ * @public
9
10
  * <p>The tag's key.</p>
10
11
  */
11
12
  Key?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>The tag's value.</p>
14
16
  */
15
17
  Value?: string;
@@ -20,12 +22,14 @@ export interface Tag {
20
22
  */
21
23
  export interface AddTagsToOnPremisesInstancesInput {
22
24
  /**
25
+ * @public
23
26
  * <p>The tag key-value pairs to add to the on-premises instances.</p>
24
27
  * <p>Keys and values are both required. Keys cannot be null or empty strings. Value-only
25
28
  * tags are not allowed.</p>
26
29
  */
27
30
  tags: Tag[] | undefined;
28
31
  /**
32
+ * @public
29
33
  * <p>The names of the on-premises instances to which to add tags.</p>
30
34
  */
31
35
  instanceNames: string[] | undefined;
@@ -121,6 +125,7 @@ export declare class TagRequiredException extends __BaseException {
121
125
  */
122
126
  export interface Alarm {
123
127
  /**
128
+ * @public
124
129
  * <p>The name of the alarm. Maximum length is 255 characters. Each alarm name can be used
125
130
  * only once in a list of alarms.</p>
126
131
  */
@@ -132,10 +137,12 @@ export interface Alarm {
132
137
  */
133
138
  export interface AlarmConfiguration {
134
139
  /**
140
+ * @public
135
141
  * <p>Indicates whether the alarm configuration is enabled.</p>
136
142
  */
137
143
  enabled?: boolean;
138
144
  /**
145
+ * @public
139
146
  * <p>Indicates whether a deployment should continue if information about the current state
140
147
  * of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.</p>
141
148
  * <ul>
@@ -153,6 +160,7 @@ export interface AlarmConfiguration {
153
160
  */
154
161
  ignorePollAlarmFailure?: boolean;
155
162
  /**
163
+ * @public
156
164
  * <p>A list of alarms configured for the deployment or deployment group. A maximum of 10
157
165
  * alarms can be added.</p>
158
166
  */
@@ -213,27 +221,33 @@ export type ComputePlatform = (typeof ComputePlatform)[keyof typeof ComputePlatf
213
221
  */
214
222
  export interface ApplicationInfo {
215
223
  /**
224
+ * @public
216
225
  * <p>The application ID.</p>
217
226
  */
218
227
  applicationId?: string;
219
228
  /**
229
+ * @public
220
230
  * <p>The application name.</p>
221
231
  */
222
232
  applicationName?: string;
223
233
  /**
234
+ * @public
224
235
  * <p>The time at which the application was created.</p>
225
236
  */
226
237
  createTime?: Date;
227
238
  /**
239
+ * @public
228
240
  * <p>True if the user has authenticated with GitHub for the specified application.
229
241
  * Otherwise, false.</p>
230
242
  */
231
243
  linkedToGitHub?: boolean;
232
244
  /**
245
+ * @public
233
246
  * <p>The name for a connection to a GitHub account.</p>
234
247
  */
235
248
  gitHubAccountName?: string;
236
249
  /**
250
+ * @public
237
251
  * <p>The destination platform type for deployment of the application (<code>Lambda</code> or <code>Server</code>).</p>
238
252
  */
239
253
  computePlatform?: ComputePlatform | string;
@@ -283,6 +297,7 @@ export type ApplicationRevisionSortBy = (typeof ApplicationRevisionSortBy)[keyof
283
297
  */
284
298
  export interface AppSpecContent {
285
299
  /**
300
+ * @public
286
301
  * <p> The YAML-formatted or JSON-formatted revision string. </p>
287
302
  * <p> For an Lambda deployment, the content includes a Lambda
288
303
  * function name, the alias for its original version, and the alias for its replacement
@@ -295,6 +310,7 @@ export interface AppSpecContent {
295
310
  */
296
311
  content?: string;
297
312
  /**
313
+ * @public
298
314
  * <p> The SHA256 hash value of the revision content. </p>
299
315
  */
300
316
  sha256?: string;
@@ -332,11 +348,13 @@ export type AutoRollbackEvent = (typeof AutoRollbackEvent)[keyof typeof AutoRoll
332
348
  */
333
349
  export interface AutoRollbackConfiguration {
334
350
  /**
351
+ * @public
335
352
  * <p>Indicates whether a defined automatic rollback configuration is currently
336
353
  * enabled.</p>
337
354
  */
338
355
  enabled?: boolean;
339
356
  /**
357
+ * @public
340
358
  * <p>The event type or types that trigger a rollback.</p>
341
359
  */
342
360
  events?: (AutoRollbackEvent | string)[];
@@ -347,10 +365,12 @@ export interface AutoRollbackConfiguration {
347
365
  */
348
366
  export interface AutoScalingGroup {
349
367
  /**
368
+ * @public
350
369
  * <p>The Auto Scaling group name.</p>
351
370
  */
352
371
  name?: string;
353
372
  /**
373
+ * @public
354
374
  * <p>An Auto Scaling lifecycle event hook name.</p>
355
375
  */
356
376
  hook?: string;
@@ -361,12 +381,14 @@ export interface AutoScalingGroup {
361
381
  */
362
382
  export interface GitHubLocation {
363
383
  /**
384
+ * @public
364
385
  * <p>The GitHub account and repository pair that stores a reference to the commit that
365
386
  * represents the bundled artifacts for the application revision. </p>
366
387
  * <p>Specified as account/repository.</p>
367
388
  */
368
389
  repository?: string;
369
390
  /**
391
+ * @public
370
392
  * <p>The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the
371
393
  * application revision.</p>
372
394
  */
@@ -407,16 +429,19 @@ export type BundleType = (typeof BundleType)[keyof typeof BundleType];
407
429
  */
408
430
  export interface S3Location {
409
431
  /**
432
+ * @public
410
433
  * <p>The name of the Amazon S3 bucket where the application revision is
411
434
  * stored.</p>
412
435
  */
413
436
  bucket?: string;
414
437
  /**
438
+ * @public
415
439
  * <p>The name of the Amazon S3 object that represents the bundled artifacts for the
416
440
  * application revision.</p>
417
441
  */
418
442
  key?: string;
419
443
  /**
444
+ * @public
420
445
  * <p>The file type of the application revision. Must be one of the following:</p>
421
446
  * <ul>
422
447
  * <li>
@@ -435,6 +460,7 @@ export interface S3Location {
435
460
  */
436
461
  bundleType?: BundleType | string;
437
462
  /**
463
+ * @public
438
464
  * <p>A specific version of the Amazon S3 object that represents the bundled
439
465
  * artifacts for the application revision.</p>
440
466
  * <p>If the version is not specified, the system uses the most recent version by
@@ -442,6 +468,7 @@ export interface S3Location {
442
468
  */
443
469
  version?: string;
444
470
  /**
471
+ * @public
445
472
  * <p>The ETag of the Amazon S3 object that represents the bundled artifacts for the
446
473
  * application revision.</p>
447
474
  * <p>If the ETag is not specified as an input parameter, ETag validation of the object is
@@ -459,12 +486,14 @@ export interface S3Location {
459
486
  */
460
487
  export interface RawString {
461
488
  /**
489
+ * @public
462
490
  * <p>The YAML-formatted or JSON-formatted revision string. It includes information about
463
491
  * which Lambda function to update and optional Lambda functions
464
492
  * that validate deployment lifecycle events.</p>
465
493
  */
466
494
  content?: string;
467
495
  /**
496
+ * @public
468
497
  * <p>The SHA256 hash value of the revision content.</p>
469
498
  */
470
499
  sha256?: string;
@@ -475,6 +504,7 @@ export interface RawString {
475
504
  */
476
505
  export interface RevisionLocation {
477
506
  /**
507
+ * @public
478
508
  * <p>The type of application revision:</p>
479
509
  * <ul>
480
510
  * <li>
@@ -498,14 +528,17 @@ export interface RevisionLocation {
498
528
  */
499
529
  revisionType?: RevisionLocationType | string;
500
530
  /**
531
+ * @public
501
532
  * <p>Information about the location of a revision stored in Amazon S3. </p>
502
533
  */
503
534
  s3Location?: S3Location;
504
535
  /**
536
+ * @public
505
537
  * <p>Information about the location of application artifacts stored in GitHub.</p>
506
538
  */
507
539
  gitHubLocation?: GitHubLocation;
508
540
  /**
541
+ * @public
509
542
  * @deprecated
510
543
  *
511
544
  * <p>Information about the location of an Lambda deployment revision stored
@@ -513,6 +546,7 @@ export interface RevisionLocation {
513
546
  */
514
547
  string?: RawString;
515
548
  /**
549
+ * @public
516
550
  * <p> The content of an AppSpec file for an Lambda or Amazon ECS
517
551
  * deployment. The content is formatted as JSON or YAML and stored as a RawString. </p>
518
552
  */
@@ -524,11 +558,13 @@ export interface RevisionLocation {
524
558
  */
525
559
  export interface BatchGetApplicationRevisionsInput {
526
560
  /**
561
+ * @public
527
562
  * <p>The name of an CodeDeploy application about which to get revision
528
563
  * information.</p>
529
564
  */
530
565
  applicationName: string | undefined;
531
566
  /**
567
+ * @public
532
568
  * <p>An array of <code>RevisionLocation</code> objects that specify information to get
533
569
  * about the application revisions, including type and location. The maximum number of
534
570
  * <code>RevisionLocation</code> objects you can specify is 25.</p>
@@ -541,22 +577,27 @@ export interface BatchGetApplicationRevisionsInput {
541
577
  */
542
578
  export interface GenericRevisionInfo {
543
579
  /**
580
+ * @public
544
581
  * <p>A comment about the revision.</p>
545
582
  */
546
583
  description?: string;
547
584
  /**
585
+ * @public
548
586
  * <p>The deployment groups for which this is the current target revision.</p>
549
587
  */
550
588
  deploymentGroups?: string[];
551
589
  /**
590
+ * @public
552
591
  * <p>When the revision was first used by CodeDeploy.</p>
553
592
  */
554
593
  firstUsedTime?: Date;
555
594
  /**
595
+ * @public
556
596
  * <p>When the revision was last used by CodeDeploy.</p>
557
597
  */
558
598
  lastUsedTime?: Date;
559
599
  /**
600
+ * @public
560
601
  * <p>When the revision was registered with CodeDeploy.</p>
561
602
  */
562
603
  registerTime?: Date;
@@ -567,10 +608,12 @@ export interface GenericRevisionInfo {
567
608
  */
568
609
  export interface RevisionInfo {
569
610
  /**
611
+ * @public
570
612
  * <p>Information about the location and type of an application revision.</p>
571
613
  */
572
614
  revisionLocation?: RevisionLocation;
573
615
  /**
616
+ * @public
574
617
  * <p>Information about an application revision, including usage details and associated
575
618
  * deployment groups.</p>
576
619
  */
@@ -582,14 +625,17 @@ export interface RevisionInfo {
582
625
  */
583
626
  export interface BatchGetApplicationRevisionsOutput {
584
627
  /**
628
+ * @public
585
629
  * <p>The name of the application that corresponds to the revisions.</p>
586
630
  */
587
631
  applicationName?: string;
588
632
  /**
633
+ * @public
589
634
  * <p>Information about errors that might have occurred during the API call.</p>
590
635
  */
591
636
  errorMessage?: string;
592
637
  /**
638
+ * @public
593
639
  * <p>Additional information about the revisions, including the type and location.</p>
594
640
  */
595
641
  revisions?: RevisionInfo[];
@@ -648,6 +694,7 @@ export declare class RevisionRequiredException extends __BaseException {
648
694
  */
649
695
  export interface BatchGetApplicationsInput {
650
696
  /**
697
+ * @public
651
698
  * <p>A list of application names separated by spaces. The maximum number of application
652
699
  * names you can specify is 100.</p>
653
700
  */
@@ -659,6 +706,7 @@ export interface BatchGetApplicationsInput {
659
706
  */
660
707
  export interface BatchGetApplicationsOutput {
661
708
  /**
709
+ * @public
662
710
  * <p>Information about the applications.</p>
663
711
  */
664
712
  applicationsInfo?: ApplicationInfo[];
@@ -669,11 +717,13 @@ export interface BatchGetApplicationsOutput {
669
717
  */
670
718
  export interface BatchGetDeploymentGroupsInput {
671
719
  /**
720
+ * @public
672
721
  * <p>The name of an CodeDeploy application associated with the applicable
673
722
  * IAM or Amazon Web Services account.</p>
674
723
  */
675
724
  applicationName: string | undefined;
676
725
  /**
726
+ * @public
677
727
  * <p>The names of the deployment groups.</p>
678
728
  */
679
729
  deploymentGroupNames: string[] | undefined;
@@ -697,6 +747,7 @@ export type DeploymentReadyAction = (typeof DeploymentReadyAction)[keyof typeof
697
747
  */
698
748
  export interface DeploymentReadyOption {
699
749
  /**
750
+ * @public
700
751
  * <p>Information about when to reroute traffic from an original environment to a
701
752
  * replacement environment in a blue/green deployment.</p>
702
753
  * <ul>
@@ -715,6 +766,7 @@ export interface DeploymentReadyOption {
715
766
  */
716
767
  actionOnTimeout?: DeploymentReadyAction | string;
717
768
  /**
769
+ * @public
718
770
  * <p>The number of minutes to wait before the status of a blue/green deployment is changed
719
771
  * to Stopped if rerouting is not started manually. Applies only to the
720
772
  * <code>STOP_DEPLOYMENT</code> option for <code>actionOnTimeout</code>.</p>
@@ -740,6 +792,7 @@ export type GreenFleetProvisioningAction = (typeof GreenFleetProvisioningAction)
740
792
  */
741
793
  export interface GreenFleetProvisioningOption {
742
794
  /**
795
+ * @public
743
796
  * <p>The method used to add instances to a replacement environment.</p>
744
797
  * <ul>
745
798
  * <li>
@@ -776,6 +829,7 @@ export type InstanceAction = (typeof InstanceAction)[keyof typeof InstanceAction
776
829
  */
777
830
  export interface BlueInstanceTerminationOption {
778
831
  /**
832
+ * @public
779
833
  * <p>The action to take on instances in the original environment after a successful
780
834
  * blue/green deployment.</p>
781
835
  * <ul>
@@ -794,6 +848,7 @@ export interface BlueInstanceTerminationOption {
794
848
  */
795
849
  action?: InstanceAction | string;
796
850
  /**
851
+ * @public
797
852
  * <p>For an Amazon EC2 deployment, the number of minutes to wait after a successful
798
853
  * blue/green deployment before terminating instances from the original environment.</p>
799
854
  *
@@ -811,16 +866,19 @@ export interface BlueInstanceTerminationOption {
811
866
  */
812
867
  export interface BlueGreenDeploymentConfiguration {
813
868
  /**
869
+ * @public
814
870
  * <p>Information about whether to terminate instances in the original fleet during a
815
871
  * blue/green deployment.</p>
816
872
  */
817
873
  terminateBlueInstancesOnDeploymentSuccess?: BlueInstanceTerminationOption;
818
874
  /**
875
+ * @public
819
876
  * <p>Information about the action to take when newly provisioned instances are ready to
820
877
  * receive traffic in a blue/green deployment.</p>
821
878
  */
822
879
  deploymentReadyOption?: DeploymentReadyOption;
823
880
  /**
881
+ * @public
824
882
  * <p>Information about how instances are provisioned for a replacement environment in a
825
883
  * blue/green deployment.</p>
826
884
  */
@@ -857,10 +915,12 @@ export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType
857
915
  */
858
916
  export interface DeploymentStyle {
859
917
  /**
918
+ * @public
860
919
  * <p>Indicates whether to run an in-place deployment or a blue/green deployment.</p>
861
920
  */
862
921
  deploymentType?: DeploymentType | string;
863
922
  /**
923
+ * @public
864
924
  * <p>Indicates whether to route deployment traffic behind a load balancer.</p>
865
925
  */
866
926
  deploymentOption?: DeploymentOption | string;
@@ -884,14 +944,17 @@ export type EC2TagFilterType = (typeof EC2TagFilterType)[keyof typeof EC2TagFilt
884
944
  */
885
945
  export interface EC2TagFilter {
886
946
  /**
947
+ * @public
887
948
  * <p>The tag filter key.</p>
888
949
  */
889
950
  Key?: string;
890
951
  /**
952
+ * @public
891
953
  * <p>The tag filter value.</p>
892
954
  */
893
955
  Value?: string;
894
956
  /**
957
+ * @public
895
958
  * <p>The tag filter type:</p>
896
959
  * <ul>
897
960
  * <li>
@@ -916,6 +979,7 @@ export interface EC2TagFilter {
916
979
  */
917
980
  export interface EC2TagSet {
918
981
  /**
982
+ * @public
919
983
  * <p>A list that contains other lists of Amazon EC2 instance tag groups. For an
920
984
  * instance to be included in the deployment group, it must be identified by all of the tag
921
985
  * groups in the list.</p>
@@ -929,10 +993,12 @@ export interface EC2TagSet {
929
993
  */
930
994
  export interface ECSService {
931
995
  /**
996
+ * @public
932
997
  * <p> The name of the target Amazon ECS service. </p>
933
998
  */
934
999
  serviceName?: string;
935
1000
  /**
1001
+ * @public
936
1002
  * <p> The name of the cluster that the Amazon ECS service is associated with.
937
1003
  * </p>
938
1004
  */
@@ -963,19 +1029,23 @@ export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof Deployment
963
1029
  */
964
1030
  export interface LastDeploymentInfo {
965
1031
  /**
1032
+ * @public
966
1033
  * <p> The unique ID of a deployment. </p>
967
1034
  */
968
1035
  deploymentId?: string;
969
1036
  /**
1037
+ * @public
970
1038
  * <p>The status of the most recent deployment.</p>
971
1039
  */
972
1040
  status?: DeploymentStatus | string;
973
1041
  /**
1042
+ * @public
974
1043
  * <p>A timestamp that indicates when the most recent deployment to the deployment group was
975
1044
  * complete.</p>
976
1045
  */
977
1046
  endTime?: Date;
978
1047
  /**
1048
+ * @public
979
1049
  * <p>A timestamp that indicates when the most recent deployment to the deployment group
980
1050
  * started.</p>
981
1051
  */
@@ -989,6 +1059,7 @@ export interface LastDeploymentInfo {
989
1059
  */
990
1060
  export interface ELBInfo {
991
1061
  /**
1062
+ * @public
992
1063
  * <p>For blue/green deployments, the name of the load balancer that is used to route
993
1064
  * traffic from original instances to replacement instances in a blue/green deployment. For
994
1065
  * in-place deployments, the name of the load balancer that instances are deregistered from
@@ -1005,6 +1076,7 @@ export interface ELBInfo {
1005
1076
  */
1006
1077
  export interface TargetGroupInfo {
1007
1078
  /**
1079
+ * @public
1008
1080
  * <p>For blue/green deployments, the name of the target group that instances in the
1009
1081
  * original environment are deregistered from, and instances in the replacement environment
1010
1082
  * are registered with. For in-place deployments, the name of the target group that
@@ -1020,6 +1092,7 @@ export interface TargetGroupInfo {
1020
1092
  */
1021
1093
  export interface TrafficRoute {
1022
1094
  /**
1095
+ * @public
1023
1096
  * <p> The Amazon Resource Name (ARN) of one listener. The listener identifies the route
1024
1097
  * between a target group and a load balancer. This is an array of strings with a maximum
1025
1098
  * size of one. </p>
@@ -1032,16 +1105,19 @@ export interface TrafficRoute {
1032
1105
  */
1033
1106
  export interface TargetGroupPairInfo {
1034
1107
  /**
1108
+ * @public
1035
1109
  * <p> One pair of target groups. One is associated with the original task set. The second
1036
1110
  * is associated with the task set that serves traffic after the deployment is complete.
1037
1111
  * </p>
1038
1112
  */
1039
1113
  targetGroups?: TargetGroupInfo[];
1040
1114
  /**
1115
+ * @public
1041
1116
  * <p> The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete. </p>
1042
1117
  */
1043
1118
  prodTrafficRoute?: TrafficRoute;
1044
1119
  /**
1120
+ * @public
1045
1121
  * <p> An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a
1046
1122
  * deployment. </p>
1047
1123
  */
@@ -1054,6 +1130,7 @@ export interface TargetGroupPairInfo {
1054
1130
  */
1055
1131
  export interface LoadBalancerInfo {
1056
1132
  /**
1133
+ * @public
1057
1134
  * <p>An array that contains information about the load balancer to use for load balancing
1058
1135
  * in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load
1059
1136
  * Balancers.</p>
@@ -1063,6 +1140,7 @@ export interface LoadBalancerInfo {
1063
1140
  */
1064
1141
  elbInfoList?: ELBInfo[];
1065
1142
  /**
1143
+ * @public
1066
1144
  * <p>An array that contains information about the target group to use for load balancing in
1067
1145
  * a deployment. In Elastic Load Balancing, target groups are used with Application Load
1068
1146
  * Balancers.</p>
@@ -1072,6 +1150,7 @@ export interface LoadBalancerInfo {
1072
1150
  */
1073
1151
  targetGroupInfoList?: TargetGroupInfo[];
1074
1152
  /**
1153
+ * @public
1075
1154
  * <p> The target group pair information. This is an array of
1076
1155
  * <code>TargeGroupPairInfo</code> objects with a maximum size of one. </p>
1077
1156
  */
@@ -1096,14 +1175,17 @@ export type TagFilterType = (typeof TagFilterType)[keyof typeof TagFilterType];
1096
1175
  */
1097
1176
  export interface TagFilter {
1098
1177
  /**
1178
+ * @public
1099
1179
  * <p>The on-premises instance tag filter key.</p>
1100
1180
  */
1101
1181
  Key?: string;
1102
1182
  /**
1183
+ * @public
1103
1184
  * <p>The on-premises instance tag filter value.</p>
1104
1185
  */
1105
1186
  Value?: string;
1106
1187
  /**
1188
+ * @public
1107
1189
  * <p>The on-premises instance tag filter type:</p>
1108
1190
  * <ul>
1109
1191
  * <li>
@@ -1125,6 +1207,7 @@ export interface TagFilter {
1125
1207
  */
1126
1208
  export interface OnPremisesTagSet {
1127
1209
  /**
1210
+ * @public
1128
1211
  * <p>A list that contains other lists of on-premises instance tag groups. For an instance
1129
1212
  * to be included in the deployment group, it must be identified by all of the tag groups
1130
1213
  * in the list.</p>
@@ -1169,15 +1252,18 @@ export type TriggerEventType = (typeof TriggerEventType)[keyof typeof TriggerEve
1169
1252
  */
1170
1253
  export interface TriggerConfig {
1171
1254
  /**
1255
+ * @public
1172
1256
  * <p>The name of the notification trigger.</p>
1173
1257
  */
1174
1258
  triggerName?: string;
1175
1259
  /**
1260
+ * @public
1176
1261
  * <p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through
1177
1262
  * which notifications about deployment or instance events are sent.</p>
1178
1263
  */
1179
1264
  triggerTargetArn?: string;
1180
1265
  /**
1266
+ * @public
1181
1267
  * <p>The event type or types for which notifications are triggered.</p>
1182
1268
  */
1183
1269
  triggerEvents?: (TriggerEventType | string)[];
@@ -1188,65 +1274,79 @@ export interface TriggerConfig {
1188
1274
  */
1189
1275
  export interface DeploymentGroupInfo {
1190
1276
  /**
1277
+ * @public
1191
1278
  * <p>The application name.</p>
1192
1279
  */
1193
1280
  applicationName?: string;
1194
1281
  /**
1282
+ * @public
1195
1283
  * <p>The deployment group ID.</p>
1196
1284
  */
1197
1285
  deploymentGroupId?: string;
1198
1286
  /**
1287
+ * @public
1199
1288
  * <p>The deployment group name.</p>
1200
1289
  */
1201
1290
  deploymentGroupName?: string;
1202
1291
  /**
1292
+ * @public
1203
1293
  * <p>The deployment configuration name.</p>
1204
1294
  */
1205
1295
  deploymentConfigName?: string;
1206
1296
  /**
1297
+ * @public
1207
1298
  * <p>The Amazon EC2 tags on which to filter. The deployment group includes EC2
1208
1299
  * instances with any of the specified tags.</p>
1209
1300
  */
1210
1301
  ec2TagFilters?: EC2TagFilter[];
1211
1302
  /**
1303
+ * @public
1212
1304
  * <p>The on-premises instance tags on which to filter. The deployment group includes
1213
1305
  * on-premises instances with any of the specified tags.</p>
1214
1306
  */
1215
1307
  onPremisesInstanceTagFilters?: TagFilter[];
1216
1308
  /**
1309
+ * @public
1217
1310
  * <p>A list of associated Auto Scaling groups.</p>
1218
1311
  */
1219
1312
  autoScalingGroups?: AutoScalingGroup[];
1220
1313
  /**
1314
+ * @public
1221
1315
  * <p>A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make
1222
1316
  * calls to Amazon Web Services services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html">Create a
1223
1317
  * Service Role for CodeDeploy</a> in the <i>CodeDeploy User Guide</i>.</p>
1224
1318
  */
1225
1319
  serviceRoleArn?: string;
1226
1320
  /**
1321
+ * @public
1227
1322
  * <p>Information about the deployment group's target revision, including type and
1228
1323
  * location.</p>
1229
1324
  */
1230
1325
  targetRevision?: RevisionLocation;
1231
1326
  /**
1327
+ * @public
1232
1328
  * <p>Information about triggers associated with the deployment group.</p>
1233
1329
  */
1234
1330
  triggerConfigurations?: TriggerConfig[];
1235
1331
  /**
1332
+ * @public
1236
1333
  * <p>A list of alarms associated with the deployment group.</p>
1237
1334
  */
1238
1335
  alarmConfiguration?: AlarmConfiguration;
1239
1336
  /**
1337
+ * @public
1240
1338
  * <p>Information about the automatic rollback configuration associated with the deployment
1241
1339
  * group.</p>
1242
1340
  */
1243
1341
  autoRollbackConfiguration?: AutoRollbackConfiguration;
1244
1342
  /**
1343
+ * @public
1245
1344
  * <p>Information about the type of deployment, either in-place or blue/green, you want to
1246
1345
  * run and whether to route deployment traffic behind a load balancer.</p>
1247
1346
  */
1248
1347
  deploymentStyle?: DeploymentStyle;
1249
1348
  /**
1349
+ * @public
1250
1350
  * <p>Indicates what happens when new Amazon EC2 instances are launched
1251
1351
  * mid-deployment and do not receive the deployed application revision.</p>
1252
1352
  * <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates
@@ -1258,40 +1358,48 @@ export interface DeploymentGroupInfo {
1258
1358
  */
1259
1359
  outdatedInstancesStrategy?: OutdatedInstancesStrategy | string;
1260
1360
  /**
1361
+ * @public
1261
1362
  * <p>Information about blue/green deployment options for a deployment group.</p>
1262
1363
  */
1263
1364
  blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
1264
1365
  /**
1366
+ * @public
1265
1367
  * <p>Information about the load balancer to use in a deployment.</p>
1266
1368
  */
1267
1369
  loadBalancerInfo?: LoadBalancerInfo;
1268
1370
  /**
1371
+ * @public
1269
1372
  * <p>Information about the most recent successful deployment to the deployment
1270
1373
  * group.</p>
1271
1374
  */
1272
1375
  lastSuccessfulDeployment?: LastDeploymentInfo;
1273
1376
  /**
1377
+ * @public
1274
1378
  * <p>Information about the most recent attempted deployment to the deployment group.</p>
1275
1379
  */
1276
1380
  lastAttemptedDeployment?: LastDeploymentInfo;
1277
1381
  /**
1382
+ * @public
1278
1383
  * <p>Information about groups of tags applied to an Amazon EC2 instance. The
1279
1384
  * deployment group includes only Amazon EC2 instances identified by all of the tag
1280
1385
  * groups. Cannot be used in the same call as ec2TagFilters.</p>
1281
1386
  */
1282
1387
  ec2TagSet?: EC2TagSet;
1283
1388
  /**
1389
+ * @public
1284
1390
  * <p>Information about groups of tags applied to an on-premises instance. The deployment
1285
1391
  * group includes only on-premises instances identified by all the tag groups. Cannot be
1286
1392
  * used in the same call as onPremisesInstanceTagFilters.</p>
1287
1393
  */
1288
1394
  onPremisesTagSet?: OnPremisesTagSet;
1289
1395
  /**
1396
+ * @public
1290
1397
  * <p>The destination platform type for the deployment (<code>Lambda</code>,
1291
1398
  * <code>Server</code>, or <code>ECS</code>).</p>
1292
1399
  */
1293
1400
  computePlatform?: ComputePlatform | string;
1294
1401
  /**
1402
+ * @public
1295
1403
  * <p> The target Amazon ECS services in the deployment group. This applies only to
1296
1404
  * deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name
1297
1405
  * pair using the format <code><clustername>:<servicename></code>. </p>
@@ -1304,10 +1412,12 @@ export interface DeploymentGroupInfo {
1304
1412
  */
1305
1413
  export interface BatchGetDeploymentGroupsOutput {
1306
1414
  /**
1415
+ * @public
1307
1416
  * <p>Information about the deployment groups.</p>
1308
1417
  */
1309
1418
  deploymentGroupsInfo?: DeploymentGroupInfo[];
1310
1419
  /**
1420
+ * @public
1311
1421
  * <p>Information about errors that might have occurred during the API call.</p>
1312
1422
  */
1313
1423
  errorMessage?: string;
@@ -1355,10 +1465,12 @@ export declare class InvalidDeploymentGroupNameException extends __BaseException
1355
1465
  */
1356
1466
  export interface BatchGetDeploymentInstancesInput {
1357
1467
  /**
1468
+ * @public
1358
1469
  * <p> The unique ID of a deployment. </p>
1359
1470
  */
1360
1471
  deploymentId: string | undefined;
1361
1472
  /**
1473
+ * @public
1362
1474
  * <p>The unique IDs of instances used in the deployment. The maximum number of instance IDs
1363
1475
  * you can specify is 25.</p>
1364
1476
  */
@@ -1398,6 +1510,7 @@ export type LifecycleErrorCode = (typeof LifecycleErrorCode)[keyof typeof Lifecy
1398
1510
  */
1399
1511
  export interface Diagnostics {
1400
1512
  /**
1513
+ * @public
1401
1514
  * <p>The associated error code:</p>
1402
1515
  * <ul>
1403
1516
  * <li>
@@ -1425,14 +1538,17 @@ export interface Diagnostics {
1425
1538
  */
1426
1539
  errorCode?: LifecycleErrorCode | string;
1427
1540
  /**
1541
+ * @public
1428
1542
  * <p>The name of the script.</p>
1429
1543
  */
1430
1544
  scriptName?: string;
1431
1545
  /**
1546
+ * @public
1432
1547
  * <p>The message associated with the error.</p>
1433
1548
  */
1434
1549
  message?: string;
1435
1550
  /**
1551
+ * @public
1436
1552
  * <p>The last portion of the diagnostic log.</p>
1437
1553
  * <p>If available, CodeDeploy returns up to the last 4 KB of the diagnostic
1438
1554
  * log.</p>
@@ -1461,24 +1577,29 @@ export type LifecycleEventStatus = (typeof LifecycleEventStatus)[keyof typeof Li
1461
1577
  */
1462
1578
  export interface LifecycleEvent {
1463
1579
  /**
1580
+ * @public
1464
1581
  * <p>The deployment lifecycle event name, such as <code>ApplicationStop</code>,
1465
1582
  * <code>BeforeInstall</code>, <code>AfterInstall</code>,
1466
1583
  * <code>ApplicationStart</code>, or <code>ValidateService</code>.</p>
1467
1584
  */
1468
1585
  lifecycleEventName?: string;
1469
1586
  /**
1587
+ * @public
1470
1588
  * <p>Diagnostic information about the deployment lifecycle event.</p>
1471
1589
  */
1472
1590
  diagnostics?: Diagnostics;
1473
1591
  /**
1592
+ * @public
1474
1593
  * <p>A timestamp that indicates when the deployment lifecycle event started.</p>
1475
1594
  */
1476
1595
  startTime?: Date;
1477
1596
  /**
1597
+ * @public
1478
1598
  * <p>A timestamp that indicates when the deployment lifecycle event ended.</p>
1479
1599
  */
1480
1600
  endTime?: Date;
1481
1601
  /**
1602
+ * @public
1482
1603
  * <p>The deployment lifecycle event status:</p>
1483
1604
  * <ul>
1484
1605
  * <li>
@@ -1528,14 +1649,17 @@ export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus
1528
1649
  */
1529
1650
  export interface InstanceSummary {
1530
1651
  /**
1652
+ * @public
1531
1653
  * <p> The unique ID of a deployment. </p>
1532
1654
  */
1533
1655
  deploymentId?: string;
1534
1656
  /**
1657
+ * @public
1535
1658
  * <p>The instance ID.</p>
1536
1659
  */
1537
1660
  instanceId?: string;
1538
1661
  /**
1662
+ * @public
1539
1663
  * @deprecated
1540
1664
  *
1541
1665
  * <p>The deployment status for this instance:</p>
@@ -1571,14 +1695,17 @@ export interface InstanceSummary {
1571
1695
  */
1572
1696
  status?: InstanceStatus | string;
1573
1697
  /**
1698
+ * @public
1574
1699
  * <p>A timestamp that indicates when the instance information was last updated.</p>
1575
1700
  */
1576
1701
  lastUpdatedAt?: Date;
1577
1702
  /**
1703
+ * @public
1578
1704
  * <p>A list of lifecycle events for this instance.</p>
1579
1705
  */
1580
1706
  lifecycleEvents?: LifecycleEvent[];
1581
1707
  /**
1708
+ * @public
1582
1709
  * <p>Information about which environment an instance belongs to in a blue/green
1583
1710
  * deployment.</p>
1584
1711
  * <ul>
@@ -1598,10 +1725,12 @@ export interface InstanceSummary {
1598
1725
  */
1599
1726
  export interface BatchGetDeploymentInstancesOutput {
1600
1727
  /**
1728
+ * @public
1601
1729
  * <p>Information about the instance.</p>
1602
1730
  */
1603
1731
  instancesSummary?: InstanceSummary[];
1604
1732
  /**
1733
+ * @public
1605
1734
  * <p>Information about errors that might have occurred during the API call.</p>
1606
1735
  */
1607
1736
  errorMessage?: string;
@@ -1675,6 +1804,7 @@ export declare class InvalidDeploymentIdException extends __BaseException {
1675
1804
  */
1676
1805
  export interface BatchGetDeploymentsInput {
1677
1806
  /**
1807
+ * @public
1678
1808
  * <p> A list of deployment IDs, separated by spaces. The maximum number of deployment IDs
1679
1809
  * you can specify is 25.</p>
1680
1810
  */
@@ -1703,27 +1833,33 @@ export type DeploymentCreator = (typeof DeploymentCreator)[keyof typeof Deployme
1703
1833
  */
1704
1834
  export interface DeploymentOverview {
1705
1835
  /**
1836
+ * @public
1706
1837
  * <p>The number of instances in the deployment in a pending state.</p>
1707
1838
  */
1708
1839
  Pending?: number;
1709
1840
  /**
1841
+ * @public
1710
1842
  * <p>The number of instances in which the deployment is in progress.</p>
1711
1843
  */
1712
1844
  InProgress?: number;
1713
1845
  /**
1846
+ * @public
1714
1847
  * <p>The number of instances in the deployment to which revisions have been successfully
1715
1848
  * deployed.</p>
1716
1849
  */
1717
1850
  Succeeded?: number;
1718
1851
  /**
1852
+ * @public
1719
1853
  * <p>The number of instances in the deployment in a failed state.</p>
1720
1854
  */
1721
1855
  Failed?: number;
1722
1856
  /**
1857
+ * @public
1723
1858
  * <p>The number of instances in the deployment in a skipped state.</p>
1724
1859
  */
1725
1860
  Skipped?: number;
1726
1861
  /**
1862
+ * @public
1727
1863
  * <p>The number of instances in a replacement environment ready to receive traffic in a
1728
1864
  * blue/green deployment.</p>
1729
1865
  */
@@ -1779,6 +1915,7 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
1779
1915
  */
1780
1916
  export interface ErrorInformation {
1781
1917
  /**
1918
+ * @public
1782
1919
  * <p>For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html">Error Codes for CodeDeploy</a> in the <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a>.</p>
1783
1920
  * <p>The error code:</p>
1784
1921
  * <ul>
@@ -1836,6 +1973,7 @@ export interface ErrorInformation {
1836
1973
  */
1837
1974
  code?: ErrorCode | string;
1838
1975
  /**
1976
+ * @public
1839
1977
  * <p>An accompanying error message.</p>
1840
1978
  */
1841
1979
  message?: string;
@@ -1859,10 +1997,12 @@ export type FileExistsBehavior = (typeof FileExistsBehavior)[keyof typeof FileEx
1859
1997
  */
1860
1998
  export interface RelatedDeployments {
1861
1999
  /**
2000
+ * @public
1862
2001
  * <p>The deployment ID of the root deployment that triggered this deployment.</p>
1863
2002
  */
1864
2003
  autoUpdateOutdatedInstancesRootDeploymentId?: string;
1865
2004
  /**
2005
+ * @public
1866
2006
  * <p>The deployment IDs of 'auto-update outdated instances' deployments triggered by this
1867
2007
  * deployment.</p>
1868
2008
  */
@@ -1874,15 +2014,18 @@ export interface RelatedDeployments {
1874
2014
  */
1875
2015
  export interface RollbackInfo {
1876
2016
  /**
2017
+ * @public
1877
2018
  * <p>The ID of the deployment rollback.</p>
1878
2019
  */
1879
2020
  rollbackDeploymentId?: string;
1880
2021
  /**
2022
+ * @public
1881
2023
  * <p>The deployment ID of the deployment that was underway and triggered a rollback
1882
2024
  * deployment because it failed or was stopped.</p>
1883
2025
  */
1884
2026
  rollbackTriggeringDeploymentId?: string;
1885
2027
  /**
2028
+ * @public
1886
2029
  * <p>Information that describes the status of a deployment rollback (for example, whether
1887
2030
  * the deployment can't be rolled back, is in progress, failed, or succeeded). </p>
1888
2031
  */
@@ -1895,17 +2038,20 @@ export interface RollbackInfo {
1895
2038
  */
1896
2039
  export interface TargetInstances {
1897
2040
  /**
2041
+ * @public
1898
2042
  * <p>The tag filter key, type, and value used to identify Amazon EC2 instances in a
1899
2043
  * replacement environment for a blue/green deployment. Cannot be used in the same call as
1900
2044
  * <code>ec2TagSet</code>.</p>
1901
2045
  */
1902
2046
  tagFilters?: EC2TagFilter[];
1903
2047
  /**
2048
+ * @public
1904
2049
  * <p>The names of one or more Auto Scaling groups to identify a replacement
1905
2050
  * environment for a blue/green deployment.</p>
1906
2051
  */
1907
2052
  autoScalingGroups?: string[];
1908
2053
  /**
2054
+ * @public
1909
2055
  * <p>Information about the groups of Amazon EC2 instance tags that an instance must
1910
2056
  * be identified by in order for it to be included in the replacement environment for a
1911
2057
  * blue/green deployment. Cannot be used in the same call as
@@ -1919,44 +2065,54 @@ export interface TargetInstances {
1919
2065
  */
1920
2066
  export interface DeploymentInfo {
1921
2067
  /**
2068
+ * @public
1922
2069
  * <p>The application name.</p>
1923
2070
  */
1924
2071
  applicationName?: string;
1925
2072
  /**
2073
+ * @public
1926
2074
  * <p> The deployment group name. </p>
1927
2075
  */
1928
2076
  deploymentGroupName?: string;
1929
2077
  /**
2078
+ * @public
1930
2079
  * <p> The deployment configuration name. </p>
1931
2080
  */
1932
2081
  deploymentConfigName?: string;
1933
2082
  /**
2083
+ * @public
1934
2084
  * <p> The unique ID of a deployment. </p>
1935
2085
  */
1936
2086
  deploymentId?: string;
1937
2087
  /**
2088
+ * @public
1938
2089
  * <p>Information about the application revision that was deployed to the deployment group
1939
2090
  * before the most recent successful deployment.</p>
1940
2091
  */
1941
2092
  previousRevision?: RevisionLocation;
1942
2093
  /**
2094
+ * @public
1943
2095
  * <p>Information about the location of stored application artifacts and the service from
1944
2096
  * which to retrieve them.</p>
1945
2097
  */
1946
2098
  revision?: RevisionLocation;
1947
2099
  /**
2100
+ * @public
1948
2101
  * <p>The current state of the deployment as a whole.</p>
1949
2102
  */
1950
2103
  status?: DeploymentStatus | string;
1951
2104
  /**
2105
+ * @public
1952
2106
  * <p>Information about any error associated with this deployment.</p>
1953
2107
  */
1954
2108
  errorInformation?: ErrorInformation;
1955
2109
  /**
2110
+ * @public
1956
2111
  * <p>A timestamp that indicates when the deployment was created.</p>
1957
2112
  */
1958
2113
  createTime?: Date;
1959
2114
  /**
2115
+ * @public
1960
2116
  * <p>A timestamp that indicates when the deployment was deployed to the deployment
1961
2117
  * group.</p>
1962
2118
  * <p>In some cases, the reported value of the start time might be later than the complete
@@ -1965,18 +2121,22 @@ export interface DeploymentInfo {
1965
2121
  */
1966
2122
  startTime?: Date;
1967
2123
  /**
2124
+ * @public
1968
2125
  * <p>A timestamp that indicates when the deployment was complete.</p>
1969
2126
  */
1970
2127
  completeTime?: Date;
1971
2128
  /**
2129
+ * @public
1972
2130
  * <p>A summary of the deployment status of the instances in the deployment.</p>
1973
2131
  */
1974
2132
  deploymentOverview?: DeploymentOverview;
1975
2133
  /**
2134
+ * @public
1976
2135
  * <p>A comment about the deployment.</p>
1977
2136
  */
1978
2137
  description?: string;
1979
2138
  /**
2139
+ * @public
1980
2140
  * <p>The means by which the deployment was created:</p>
1981
2141
  * <ul>
1982
2142
  * <li>
@@ -2001,6 +2161,7 @@ export interface DeploymentInfo {
2001
2161
  */
2002
2162
  creator?: DeploymentCreator | string;
2003
2163
  /**
2164
+ * @public
2004
2165
  * <p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or
2005
2166
  * <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then
2006
2167
  * the deployment continues to the next deployment lifecycle event. For example, if
@@ -2029,44 +2190,53 @@ export interface DeploymentInfo {
2029
2190
  */
2030
2191
  ignoreApplicationStopFailures?: boolean;
2031
2192
  /**
2193
+ * @public
2032
2194
  * <p>Information about the automatic rollback configuration associated with the
2033
2195
  * deployment.</p>
2034
2196
  */
2035
2197
  autoRollbackConfiguration?: AutoRollbackConfiguration;
2036
2198
  /**
2199
+ * @public
2037
2200
  * <p>Indicates whether only instances that are not running the latest application revision
2038
2201
  * are to be deployed to.</p>
2039
2202
  */
2040
2203
  updateOutdatedInstancesOnly?: boolean;
2041
2204
  /**
2205
+ * @public
2042
2206
  * <p>Information about a deployment rollback.</p>
2043
2207
  */
2044
2208
  rollbackInfo?: RollbackInfo;
2045
2209
  /**
2210
+ * @public
2046
2211
  * <p>Information about the type of deployment, either in-place or blue/green, you want to
2047
2212
  * run and whether to route deployment traffic behind a load balancer.</p>
2048
2213
  */
2049
2214
  deploymentStyle?: DeploymentStyle;
2050
2215
  /**
2216
+ * @public
2051
2217
  * <p>Information about the instances that belong to the replacement environment in a
2052
2218
  * blue/green deployment.</p>
2053
2219
  */
2054
2220
  targetInstances?: TargetInstances;
2055
2221
  /**
2222
+ * @public
2056
2223
  * <p>Indicates whether the wait period set for the termination of instances in the original
2057
2224
  * environment has started. Status is 'false' if the KEEP_ALIVE option is specified.
2058
2225
  * Otherwise, 'true' as soon as the termination wait period starts.</p>
2059
2226
  */
2060
2227
  instanceTerminationWaitTimeStarted?: boolean;
2061
2228
  /**
2229
+ * @public
2062
2230
  * <p>Information about blue/green deployment options for this deployment.</p>
2063
2231
  */
2064
2232
  blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
2065
2233
  /**
2234
+ * @public
2066
2235
  * <p>Information about the load balancer used in the deployment.</p>
2067
2236
  */
2068
2237
  loadBalancerInfo?: LoadBalancerInfo;
2069
2238
  /**
2239
+ * @public
2070
2240
  * @deprecated
2071
2241
  *
2072
2242
  * <p>Provides information about the results of a deployment, such as whether instances in
@@ -2074,6 +2244,7 @@ export interface DeploymentInfo {
2074
2244
  */
2075
2245
  additionalDeploymentStatusInfo?: string;
2076
2246
  /**
2247
+ * @public
2077
2248
  * <p>Information about how CodeDeploy handles files that already exist in a
2078
2249
  * deployment target location but weren't part of the previous successful
2079
2250
  * deployment.</p>
@@ -2097,24 +2268,29 @@ export interface DeploymentInfo {
2097
2268
  */
2098
2269
  fileExistsBehavior?: FileExistsBehavior | string;
2099
2270
  /**
2271
+ * @public
2100
2272
  * <p>Messages that contain information about the status of a deployment.</p>
2101
2273
  */
2102
2274
  deploymentStatusMessages?: string[];
2103
2275
  /**
2276
+ * @public
2104
2277
  * <p>The destination platform type for the deployment (<code>Lambda</code>,
2105
2278
  * <code>Server</code>, or <code>ECS</code>).</p>
2106
2279
  */
2107
2280
  computePlatform?: ComputePlatform | string;
2108
2281
  /**
2282
+ * @public
2109
2283
  * <p>The unique ID for an external resource (for example, a CloudFormation stack
2110
2284
  * ID) that is linked to this deployment.</p>
2111
2285
  */
2112
2286
  externalId?: string;
2113
2287
  /**
2288
+ * @public
2114
2289
  * <p>Information about deployments related to the specified deployment.</p>
2115
2290
  */
2116
2291
  relatedDeployments?: RelatedDeployments;
2117
2292
  /**
2293
+ * @public
2118
2294
  * <p>Information about alarms associated with a deployment or deployment group.</p>
2119
2295
  */
2120
2296
  overrideAlarmConfiguration?: AlarmConfiguration;
@@ -2125,6 +2301,7 @@ export interface DeploymentInfo {
2125
2301
  */
2126
2302
  export interface BatchGetDeploymentsOutput {
2127
2303
  /**
2304
+ * @public
2128
2305
  * <p> Information about the deployments. </p>
2129
2306
  */
2130
2307
  deploymentsInfo?: DeploymentInfo[];
@@ -2134,10 +2311,12 @@ export interface BatchGetDeploymentsOutput {
2134
2311
  */
2135
2312
  export interface BatchGetDeploymentTargetsInput {
2136
2313
  /**
2314
+ * @public
2137
2315
  * <p> The unique ID of a deployment. </p>
2138
2316
  */
2139
2317
  deploymentId?: string;
2140
2318
  /**
2319
+ * @public
2141
2320
  * <p> The unique IDs of the deployment targets. The compute platform of the deployment
2142
2321
  * determines the type of the targets and their formats. The maximum number of deployment
2143
2322
  * target IDs you can specify is 25.</p>
@@ -2191,34 +2370,41 @@ export type TargetStatus = (typeof TargetStatus)[keyof typeof TargetStatus];
2191
2370
  */
2192
2371
  export interface CloudFormationTarget {
2193
2372
  /**
2373
+ * @public
2194
2374
  * <p>The unique ID of an CloudFormation blue/green deployment.</p>
2195
2375
  */
2196
2376
  deploymentId?: string;
2197
2377
  /**
2378
+ * @public
2198
2379
  * <p> The unique ID of a deployment target that has a type
2199
2380
  * of <code>CloudFormationTarget</code>. </p>
2200
2381
  */
2201
2382
  targetId?: string;
2202
2383
  /**
2384
+ * @public
2203
2385
  * <p> The date and time when the target application was updated by an CloudFormation
2204
2386
  * blue/green deployment. </p>
2205
2387
  */
2206
2388
  lastUpdatedAt?: Date;
2207
2389
  /**
2390
+ * @public
2208
2391
  * <p> The lifecycle events of the CloudFormation blue/green deployment to this target
2209
2392
  * application. </p>
2210
2393
  */
2211
2394
  lifecycleEvents?: LifecycleEvent[];
2212
2395
  /**
2396
+ * @public
2213
2397
  * <p> The status of an CloudFormation blue/green deployment's target application.
2214
2398
  * </p>
2215
2399
  */
2216
2400
  status?: TargetStatus | string;
2217
2401
  /**
2402
+ * @public
2218
2403
  * <p>The resource type for the CloudFormation blue/green deployment.</p>
2219
2404
  */
2220
2405
  resourceType?: string;
2221
2406
  /**
2407
+ * @public
2222
2408
  * <p>The percentage of production traffic that the target version of an CloudFormation
2223
2409
  * blue/green deployment receives.</p>
2224
2410
  */
@@ -2261,16 +2447,19 @@ export type TargetLabel = (typeof TargetLabel)[keyof typeof TargetLabel];
2261
2447
  */
2262
2448
  export interface ECSTaskSet {
2263
2449
  /**
2450
+ * @public
2264
2451
  * <p> A unique ID of an <code>ECSTaskSet</code>. </p>
2265
2452
  */
2266
2453
  identifer?: string;
2267
2454
  /**
2455
+ * @public
2268
2456
  * <p> The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and
2269
2457
  * uses this value to determine how many tasks to create. After the updated task set is
2270
2458
  * created, CodeDeploy shifts traffic to the new task set. </p>
2271
2459
  */
2272
2460
  desiredCount?: number;
2273
2461
  /**
2462
+ * @public
2274
2463
  * <p> The number of tasks in the task set that are in the <code>PENDING</code> status
2275
2464
  * during an Amazon ECS deployment. A task in the <code>PENDING</code> state is
2276
2465
  * preparing to enter the <code>RUNNING</code> state. A task set enters the
@@ -2279,12 +2468,14 @@ export interface ECSTaskSet {
2279
2468
  */
2280
2469
  pendingCount?: number;
2281
2470
  /**
2471
+ * @public
2282
2472
  * <p> The number of tasks in the task set that are in the <code>RUNNING</code> status
2283
2473
  * during an Amazon ECS deployment. A task in the <code>RUNNING</code> state is
2284
2474
  * running and ready for use. </p>
2285
2475
  */
2286
2476
  runningCount?: number;
2287
2477
  /**
2478
+ * @public
2288
2479
  * <p> The status of the task set. There are three valid task set statuses: </p>
2289
2480
  * <ul>
2290
2481
  * <li>
@@ -2307,14 +2498,17 @@ export interface ECSTaskSet {
2307
2498
  */
2308
2499
  status?: string;
2309
2500
  /**
2501
+ * @public
2310
2502
  * <p> The percentage of traffic served by this task set. </p>
2311
2503
  */
2312
2504
  trafficWeight?: number;
2313
2505
  /**
2506
+ * @public
2314
2507
  * <p> The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set. </p>
2315
2508
  */
2316
2509
  targetGroup?: TargetGroupInfo;
2317
2510
  /**
2511
+ * @public
2318
2512
  * <p> A label that identifies whether the ECS task set is an original target
2319
2513
  * (<code>BLUE</code>) or a replacement target (<code>GREEN</code>). </p>
2320
2514
  */
@@ -2326,33 +2520,40 @@ export interface ECSTaskSet {
2326
2520
  */
2327
2521
  export interface ECSTarget {
2328
2522
  /**
2523
+ * @public
2329
2524
  * <p> The unique ID of a deployment. </p>
2330
2525
  */
2331
2526
  deploymentId?: string;
2332
2527
  /**
2528
+ * @public
2333
2529
  * <p> The unique ID of a deployment target that has a type of <code>ecsTarget</code>.
2334
2530
  * </p>
2335
2531
  */
2336
2532
  targetId?: string;
2337
2533
  /**
2534
+ * @public
2338
2535
  * <p> The Amazon Resource Name (ARN) of the target. </p>
2339
2536
  */
2340
2537
  targetArn?: string;
2341
2538
  /**
2539
+ * @public
2342
2540
  * <p> The date and time when the target Amazon ECS application was updated by a
2343
2541
  * deployment. </p>
2344
2542
  */
2345
2543
  lastUpdatedAt?: Date;
2346
2544
  /**
2545
+ * @public
2347
2546
  * <p> The lifecycle events of the deployment to this target Amazon ECS application.
2348
2547
  * </p>
2349
2548
  */
2350
2549
  lifecycleEvents?: LifecycleEvent[];
2351
2550
  /**
2551
+ * @public
2352
2552
  * <p> The status an Amazon ECS deployment's target ECS application. </p>
2353
2553
  */
2354
2554
  status?: TargetStatus | string;
2355
2555
  /**
2556
+ * @public
2356
2557
  * <p> The <code>ECSTaskSet</code> objects associated with the ECS target. </p>
2357
2558
  */
2358
2559
  taskSetsInfo?: ECSTaskSet[];
@@ -2364,31 +2565,38 @@ export interface ECSTarget {
2364
2565
  */
2365
2566
  export interface InstanceTarget {
2366
2567
  /**
2568
+ * @public
2367
2569
  * <p> The unique ID of a deployment. </p>
2368
2570
  */
2369
2571
  deploymentId?: string;
2370
2572
  /**
2573
+ * @public
2371
2574
  * <p> The unique ID of a deployment target that has a type of <code>instanceTarget</code>.
2372
2575
  * </p>
2373
2576
  */
2374
2577
  targetId?: string;
2375
2578
  /**
2579
+ * @public
2376
2580
  * <p> The Amazon Resource Name (ARN) of the target. </p>
2377
2581
  */
2378
2582
  targetArn?: string;
2379
2583
  /**
2584
+ * @public
2380
2585
  * <p> The status an EC2/On-premises deployment's target instance. </p>
2381
2586
  */
2382
2587
  status?: TargetStatus | string;
2383
2588
  /**
2589
+ * @public
2384
2590
  * <p> The date and time when the target instance was updated by a deployment. </p>
2385
2591
  */
2386
2592
  lastUpdatedAt?: Date;
2387
2593
  /**
2594
+ * @public
2388
2595
  * <p> The lifecycle events of the deployment to this target instance. </p>
2389
2596
  */
2390
2597
  lifecycleEvents?: LifecycleEvent[];
2391
2598
  /**
2599
+ * @public
2392
2600
  * <p> A label that identifies whether the instance is an original target
2393
2601
  * (<code>BLUE</code>) or a replacement target (<code>GREEN</code>). </p>
2394
2602
  */
@@ -2400,25 +2608,30 @@ export interface InstanceTarget {
2400
2608
  */
2401
2609
  export interface LambdaFunctionInfo {
2402
2610
  /**
2611
+ * @public
2403
2612
  * <p> The name of a Lambda function. </p>
2404
2613
  */
2405
2614
  functionName?: string;
2406
2615
  /**
2616
+ * @public
2407
2617
  * <p> The alias of a Lambda function. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Lambda Function Aliases</a> in the <i>Lambda Developer
2408
2618
  * Guide</i>.</p>
2409
2619
  */
2410
2620
  functionAlias?: string;
2411
2621
  /**
2622
+ * @public
2412
2623
  * <p> The version of a Lambda function that production traffic points to.
2413
2624
  * </p>
2414
2625
  */
2415
2626
  currentVersion?: string;
2416
2627
  /**
2628
+ * @public
2417
2629
  * <p> The version of a Lambda function that production traffic points to after
2418
2630
  * the Lambda function is deployed. </p>
2419
2631
  */
2420
2632
  targetVersion?: string;
2421
2633
  /**
2634
+ * @public
2422
2635
  * <p> The percentage of production traffic that the target version of a Lambda
2423
2636
  * function receives. </p>
2424
2637
  */
@@ -2430,34 +2643,41 @@ export interface LambdaFunctionInfo {
2430
2643
  */
2431
2644
  export interface LambdaTarget {
2432
2645
  /**
2646
+ * @public
2433
2647
  * <p> The unique ID of a deployment. </p>
2434
2648
  */
2435
2649
  deploymentId?: string;
2436
2650
  /**
2651
+ * @public
2437
2652
  * <p> The unique ID of a deployment target that has a type of <code>lambdaTarget</code>.
2438
2653
  * </p>
2439
2654
  */
2440
2655
  targetId?: string;
2441
2656
  /**
2657
+ * @public
2442
2658
  * <p> The Amazon Resource Name (ARN) of the target. </p>
2443
2659
  */
2444
2660
  targetArn?: string;
2445
2661
  /**
2662
+ * @public
2446
2663
  * <p> The status an Lambda deployment's target Lambda function.
2447
2664
  * </p>
2448
2665
  */
2449
2666
  status?: TargetStatus | string;
2450
2667
  /**
2668
+ * @public
2451
2669
  * <p> The date and time when the target Lambda function was updated by a
2452
2670
  * deployment. </p>
2453
2671
  */
2454
2672
  lastUpdatedAt?: Date;
2455
2673
  /**
2674
+ * @public
2456
2675
  * <p> The lifecycle events of the deployment to this target Lambda function.
2457
2676
  * </p>
2458
2677
  */
2459
2678
  lifecycleEvents?: LifecycleEvent[];
2460
2679
  /**
2680
+ * @public
2461
2681
  * <p> A <code>LambdaFunctionInfo</code> object that describes a target Lambda
2462
2682
  * function. </p>
2463
2683
  */
@@ -2469,26 +2689,31 @@ export interface LambdaTarget {
2469
2689
  */
2470
2690
  export interface DeploymentTarget {
2471
2691
  /**
2692
+ * @public
2472
2693
  * <p>The deployment type that is specific to the deployment's compute platform or
2473
2694
  * deployments initiated by a CloudFormation stack update.</p>
2474
2695
  */
2475
2696
  deploymentTargetType?: DeploymentTargetType | string;
2476
2697
  /**
2698
+ * @public
2477
2699
  * <p> Information about the target for a deployment that uses the EC2/On-premises compute
2478
2700
  * platform. </p>
2479
2701
  */
2480
2702
  instanceTarget?: InstanceTarget;
2481
2703
  /**
2704
+ * @public
2482
2705
  * <p> Information about the target for a deployment that uses the Lambda
2483
2706
  * compute platform. </p>
2484
2707
  */
2485
2708
  lambdaTarget?: LambdaTarget;
2486
2709
  /**
2710
+ * @public
2487
2711
  * <p> Information about the target for a deployment that uses the Amazon ECS
2488
2712
  * compute platform. </p>
2489
2713
  */
2490
2714
  ecsTarget?: ECSTarget;
2491
2715
  /**
2716
+ * @public
2492
2717
  * <p> Information about the target to be updated by an CloudFormation blue/green
2493
2718
  * deployment. This target type is used for all deployments initiated by a CloudFormation stack update.</p>
2494
2719
  */
@@ -2499,6 +2724,7 @@ export interface DeploymentTarget {
2499
2724
  */
2500
2725
  export interface BatchGetDeploymentTargetsOutput {
2501
2726
  /**
2727
+ * @public
2502
2728
  * <p> A list of target objects for a deployment. Each target object contains details about
2503
2729
  * the target, such as its status and lifecycle events. The type of the target objects
2504
2730
  * depends on the deployment' compute platform. </p>
@@ -2610,6 +2836,7 @@ export declare class InvalidDeploymentTargetIdException extends __BaseException
2610
2836
  */
2611
2837
  export interface BatchGetOnPremisesInstancesInput {
2612
2838
  /**
2839
+ * @public
2613
2840
  * <p>The names of the on-premises instances about which to get information. The maximum
2614
2841
  * number of instance names you can specify is 25.</p>
2615
2842
  */
@@ -2621,31 +2848,38 @@ export interface BatchGetOnPremisesInstancesInput {
2621
2848
  */
2622
2849
  export interface InstanceInfo {
2623
2850
  /**
2851
+ * @public
2624
2852
  * <p>The name of the on-premises instance.</p>
2625
2853
  */
2626
2854
  instanceName?: string;
2627
2855
  /**
2856
+ * @public
2628
2857
  * <p>The ARN of the IAM session associated with the on-premises instance.</p>
2629
2858
  */
2630
2859
  iamSessionArn?: string;
2631
2860
  /**
2861
+ * @public
2632
2862
  * <p>The IAM user ARN associated with the on-premises instance.</p>
2633
2863
  */
2634
2864
  iamUserArn?: string;
2635
2865
  /**
2866
+ * @public
2636
2867
  * <p>The ARN of the on-premises instance.</p>
2637
2868
  */
2638
2869
  instanceArn?: string;
2639
2870
  /**
2871
+ * @public
2640
2872
  * <p>The time at which the on-premises instance was registered.</p>
2641
2873
  */
2642
2874
  registerTime?: Date;
2643
2875
  /**
2876
+ * @public
2644
2877
  * <p>If the on-premises instance was deregistered, the time at which the on-premises
2645
2878
  * instance was deregistered.</p>
2646
2879
  */
2647
2880
  deregisterTime?: Date;
2648
2881
  /**
2882
+ * @public
2649
2883
  * <p>The tags currently associated with the on-premises instance.</p>
2650
2884
  */
2651
2885
  tags?: Tag[];
@@ -2656,6 +2890,7 @@ export interface InstanceInfo {
2656
2890
  */
2657
2891
  export interface BatchGetOnPremisesInstancesOutput {
2658
2892
  /**
2893
+ * @public
2659
2894
  * <p>Information about the on-premises instances.</p>
2660
2895
  */
2661
2896
  instanceInfos?: InstanceInfo[];
@@ -2689,11 +2924,13 @@ export type DeploymentWaitType = (typeof DeploymentWaitType)[keyof typeof Deploy
2689
2924
  */
2690
2925
  export interface ContinueDeploymentInput {
2691
2926
  /**
2927
+ * @public
2692
2928
  * <p> The unique ID of a blue/green deployment for which you want to start rerouting
2693
2929
  * traffic to the replacement environment. </p>
2694
2930
  */
2695
2931
  deploymentId?: string;
2696
2932
  /**
2933
+ * @public
2697
2934
  * <p> The status of the deployment's waiting period. <code>READY_WAIT</code> indicates that
2698
2935
  * the deployment is ready to start shifting traffic. <code>TERMINATION_WAIT</code>
2699
2936
  * indicates that the traffic is shifted, but the original target is not terminated.
@@ -2767,15 +3004,18 @@ export declare class UnsupportedActionForDeploymentTypeException extends __BaseE
2767
3004
  */
2768
3005
  export interface CreateApplicationInput {
2769
3006
  /**
3007
+ * @public
2770
3008
  * <p>The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.</p>
2771
3009
  */
2772
3010
  applicationName: string | undefined;
2773
3011
  /**
3012
+ * @public
2774
3013
  * <p> The destination platform type for the deployment (<code>Lambda</code>,
2775
3014
  * <code>Server</code>, or <code>ECS</code>).</p>
2776
3015
  */
2777
3016
  computePlatform?: ComputePlatform | string;
2778
3017
  /**
3018
+ * @public
2779
3019
  * <p> The metadata that you apply to CodeDeploy applications to help you organize and
2780
3020
  * categorize them. Each tag consists of a key and an optional value, both of which you
2781
3021
  * define. </p>
@@ -2788,6 +3028,7 @@ export interface CreateApplicationInput {
2788
3028
  */
2789
3029
  export interface CreateApplicationOutput {
2790
3030
  /**
3031
+ * @public
2791
3032
  * <p>A unique application ID.</p>
2792
3033
  */
2793
3034
  applicationId?: string;
@@ -2810,18 +3051,22 @@ export declare class InvalidTagsToAddException extends __BaseException {
2810
3051
  */
2811
3052
  export interface CreateDeploymentInput {
2812
3053
  /**
3054
+ * @public
2813
3055
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
2814
3056
  */
2815
3057
  applicationName: string | undefined;
2816
3058
  /**
3059
+ * @public
2817
3060
  * <p>The name of the deployment group.</p>
2818
3061
  */
2819
3062
  deploymentGroupName?: string;
2820
3063
  /**
3064
+ * @public
2821
3065
  * <p> The type and location of the revision to deploy. </p>
2822
3066
  */
2823
3067
  revision?: RevisionLocation;
2824
3068
  /**
3069
+ * @public
2825
3070
  * <p>The name of a deployment configuration associated with the IAM user or
2826
3071
  * Amazon Web Services account.</p>
2827
3072
  * <p>If not specified, the value configured in the deployment group is used as the default.
@@ -2830,10 +3075,12 @@ export interface CreateDeploymentInput {
2830
3075
  */
2831
3076
  deploymentConfigName?: string;
2832
3077
  /**
3078
+ * @public
2833
3079
  * <p>A comment about the deployment.</p>
2834
3080
  */
2835
3081
  description?: string;
2836
3082
  /**
3083
+ * @public
2837
3084
  * <p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or
2838
3085
  * <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then
2839
3086
  * the deployment continues to the next deployment lifecycle event. For example, if
@@ -2862,21 +3109,25 @@ export interface CreateDeploymentInput {
2862
3109
  */
2863
3110
  ignoreApplicationStopFailures?: boolean;
2864
3111
  /**
3112
+ * @public
2865
3113
  * <p> Information about the instances that belong to the replacement environment in a
2866
3114
  * blue/green deployment. </p>
2867
3115
  */
2868
3116
  targetInstances?: TargetInstances;
2869
3117
  /**
3118
+ * @public
2870
3119
  * <p>Configuration information for an automatic rollback that is added when a deployment is
2871
3120
  * created.</p>
2872
3121
  */
2873
3122
  autoRollbackConfiguration?: AutoRollbackConfiguration;
2874
3123
  /**
3124
+ * @public
2875
3125
  * <p> Indicates whether to deploy to all instances or only to instances that are not
2876
3126
  * running the latest application revision. </p>
2877
3127
  */
2878
3128
  updateOutdatedInstancesOnly?: boolean;
2879
3129
  /**
3130
+ * @public
2880
3131
  * <p>Information about how CodeDeploy handles files that already exist in a
2881
3132
  * deployment target location but weren't part of the previous successful
2882
3133
  * deployment.</p>
@@ -2899,6 +3150,7 @@ export interface CreateDeploymentInput {
2899
3150
  */
2900
3151
  fileExistsBehavior?: FileExistsBehavior | string;
2901
3152
  /**
3153
+ * @public
2902
3154
  * <p>Allows you to specify information about alarms associated with a deployment. The alarm
2903
3155
  * configuration that you specify here will override the alarm configuration at the
2904
3156
  * deployment group level. Consider overriding the alarm configuration if you have set up
@@ -2922,6 +3174,7 @@ export interface CreateDeploymentInput {
2922
3174
  */
2923
3175
  export interface CreateDeploymentOutput {
2924
3176
  /**
3177
+ * @public
2925
3178
  * <p> The unique ID of a deployment. </p>
2926
3179
  */
2927
3180
  deploymentId?: string;
@@ -3192,6 +3445,7 @@ export type MinimumHealthyHostsType = (typeof MinimumHealthyHostsType)[keyof typ
3192
3445
  */
3193
3446
  export interface MinimumHealthyHosts {
3194
3447
  /**
3448
+ * @public
3195
3449
  * <p>The minimum healthy instance type:</p>
3196
3450
  * <ul>
3197
3451
  * <li>
@@ -3228,6 +3482,7 @@ export interface MinimumHealthyHosts {
3228
3482
  */
3229
3483
  type?: MinimumHealthyHostsType | string;
3230
3484
  /**
3485
+ * @public
3231
3486
  * <p>The minimum healthy instance value.</p>
3232
3487
  */
3233
3488
  value?: number;
@@ -3241,11 +3496,13 @@ export interface MinimumHealthyHosts {
3241
3496
  */
3242
3497
  export interface TimeBasedCanary {
3243
3498
  /**
3499
+ * @public
3244
3500
  * <p>The percentage of traffic to shift in the first increment of a
3245
3501
  * <code>TimeBasedCanary</code> deployment.</p>
3246
3502
  */
3247
3503
  canaryPercentage?: number;
3248
3504
  /**
3505
+ * @public
3249
3506
  * <p>The number of minutes between the first and second traffic shifts of a
3250
3507
  * <code>TimeBasedCanary</code> deployment.</p>
3251
3508
  */
@@ -3260,11 +3517,13 @@ export interface TimeBasedCanary {
3260
3517
  */
3261
3518
  export interface TimeBasedLinear {
3262
3519
  /**
3520
+ * @public
3263
3521
  * <p>The percentage of traffic that is shifted at the start of each increment of a
3264
3522
  * <code>TimeBasedLinear</code> deployment.</p>
3265
3523
  */
3266
3524
  linearPercentage?: number;
3267
3525
  /**
3526
+ * @public
3268
3527
  * <p>The number of minutes between each incremental traffic shift of a
3269
3528
  * <code>TimeBasedLinear</code> deployment.</p>
3270
3529
  */
@@ -3291,11 +3550,13 @@ export type TrafficRoutingType = (typeof TrafficRoutingType)[keyof typeof Traffi
3291
3550
  */
3292
3551
  export interface TrafficRoutingConfig {
3293
3552
  /**
3553
+ * @public
3294
3554
  * <p>The type of traffic shifting (<code>TimeBasedCanary</code> or
3295
3555
  * <code>TimeBasedLinear</code>) used by a deployment configuration.</p>
3296
3556
  */
3297
3557
  type?: TrafficRoutingType | string;
3298
3558
  /**
3559
+ * @public
3299
3560
  * <p>A configuration that shifts traffic from one version of a Lambda function
3300
3561
  * or ECS task set to another in two increments. The original and target Lambda
3301
3562
  * function versions or ECS task sets are specified in the deployment's AppSpec
@@ -3303,6 +3564,7 @@ export interface TrafficRoutingConfig {
3303
3564
  */
3304
3565
  timeBasedCanary?: TimeBasedCanary;
3305
3566
  /**
3567
+ * @public
3306
3568
  * <p>A configuration that shifts traffic from one version of a Lambda function
3307
3569
  * or Amazon ECS task set to another in equal increments, with an equal number of
3308
3570
  * minutes between each increment. The original and target Lambda function
@@ -3317,10 +3579,12 @@ export interface TrafficRoutingConfig {
3317
3579
  */
3318
3580
  export interface CreateDeploymentConfigInput {
3319
3581
  /**
3582
+ * @public
3320
3583
  * <p>The name of the deployment configuration to create.</p>
3321
3584
  */
3322
3585
  deploymentConfigName: string | undefined;
3323
3586
  /**
3587
+ * @public
3324
3588
  * <p>The minimum number of healthy instances that should be available at any time during
3325
3589
  * the deployment. There are two parameters expected in the input: type and value.</p>
3326
3590
  * <p>The type parameter takes either of the following values:</p>
@@ -3342,10 +3606,12 @@ export interface CreateDeploymentConfigInput {
3342
3606
  */
3343
3607
  minimumHealthyHosts?: MinimumHealthyHosts;
3344
3608
  /**
3609
+ * @public
3345
3610
  * <p>The configuration that specifies how the deployment traffic is routed.</p>
3346
3611
  */
3347
3612
  trafficRoutingConfig?: TrafficRoutingConfig;
3348
3613
  /**
3614
+ * @public
3349
3615
  * <p>The destination platform type for the deployment (<code>Lambda</code>,
3350
3616
  * <code>Server</code>, or <code>ECS</code>).</p>
3351
3617
  */
@@ -3357,6 +3623,7 @@ export interface CreateDeploymentConfigInput {
3357
3623
  */
3358
3624
  export interface CreateDeploymentConfigOutput {
3359
3625
  /**
3626
+ * @public
3360
3627
  * <p>A unique deployment configuration ID.</p>
3361
3628
  */
3362
3629
  deploymentConfigId?: string;
@@ -3416,14 +3683,17 @@ export declare class InvalidMinimumHealthyHostValueException extends __BaseExcep
3416
3683
  */
3417
3684
  export interface CreateDeploymentGroupInput {
3418
3685
  /**
3686
+ * @public
3419
3687
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
3420
3688
  */
3421
3689
  applicationName: string | undefined;
3422
3690
  /**
3691
+ * @public
3423
3692
  * <p>The name of a new deployment group for the specified application.</p>
3424
3693
  */
3425
3694
  deploymentGroupName: string | undefined;
3426
3695
  /**
3696
+ * @public
3427
3697
  * <p>If specified, the deployment configuration name can be either one of the predefined
3428
3698
  * configurations provided with CodeDeploy or a custom deployment configuration
3429
3699
  * that you create by calling the create deployment configuration operation.</p>
@@ -3436,26 +3706,31 @@ export interface CreateDeploymentGroupInput {
3436
3706
  */
3437
3707
  deploymentConfigName?: string;
3438
3708
  /**
3709
+ * @public
3439
3710
  * <p>The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call
3440
3711
  * as ec2TagSet.</p>
3441
3712
  */
3442
3713
  ec2TagFilters?: EC2TagFilter[];
3443
3714
  /**
3715
+ * @public
3444
3716
  * <p>The on-premises instance tags on which to filter. The deployment group includes
3445
3717
  * on-premises instances with any of the specified tags. Cannot be used in the same call as
3446
3718
  * <code>OnPremisesTagSet</code>.</p>
3447
3719
  */
3448
3720
  onPremisesInstanceTagFilters?: TagFilter[];
3449
3721
  /**
3722
+ * @public
3450
3723
  * <p>A list of associated Amazon EC2 Auto Scaling groups.</p>
3451
3724
  */
3452
3725
  autoScalingGroups?: string[];
3453
3726
  /**
3727
+ * @public
3454
3728
  * <p>A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on
3455
3729
  * the user's behalf when interacting with Amazon Web Services services.</p>
3456
3730
  */
3457
3731
  serviceRoleArn: string | undefined;
3458
3732
  /**
3733
+ * @public
3459
3734
  * <p>Information about triggers to create when the deployment group is created. For
3460
3735
  * examples, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html">Create a Trigger for an
3461
3736
  * CodeDeploy Event</a> in the <i>CodeDeploy
@@ -3463,16 +3738,19 @@ export interface CreateDeploymentGroupInput {
3463
3738
  */
3464
3739
  triggerConfigurations?: TriggerConfig[];
3465
3740
  /**
3741
+ * @public
3466
3742
  * <p>Information to add about Amazon CloudWatch alarms when the deployment group is
3467
3743
  * created.</p>
3468
3744
  */
3469
3745
  alarmConfiguration?: AlarmConfiguration;
3470
3746
  /**
3747
+ * @public
3471
3748
  * <p>Configuration information for an automatic rollback that is added when a deployment
3472
3749
  * group is created.</p>
3473
3750
  */
3474
3751
  autoRollbackConfiguration?: AutoRollbackConfiguration;
3475
3752
  /**
3753
+ * @public
3476
3754
  * <p>Indicates what happens when new Amazon EC2 instances are launched
3477
3755
  * mid-deployment and do not receive the deployed application revision.</p>
3478
3756
  * <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates
@@ -3484,37 +3762,44 @@ export interface CreateDeploymentGroupInput {
3484
3762
  */
3485
3763
  outdatedInstancesStrategy?: OutdatedInstancesStrategy | string;
3486
3764
  /**
3765
+ * @public
3487
3766
  * <p>Information about the type of deployment, in-place or blue/green, that you want to run
3488
3767
  * and whether to route deployment traffic behind a load balancer.</p>
3489
3768
  */
3490
3769
  deploymentStyle?: DeploymentStyle;
3491
3770
  /**
3771
+ * @public
3492
3772
  * <p>Information about blue/green deployment options for a deployment group.</p>
3493
3773
  */
3494
3774
  blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
3495
3775
  /**
3776
+ * @public
3496
3777
  * <p>Information about the load balancer used in a deployment.</p>
3497
3778
  */
3498
3779
  loadBalancerInfo?: LoadBalancerInfo;
3499
3780
  /**
3781
+ * @public
3500
3782
  * <p>Information about groups of tags applied to Amazon EC2 instances. The
3501
3783
  * deployment group includes only Amazon EC2 instances identified by all the tag
3502
3784
  * groups. Cannot be used in the same call as <code>ec2TagFilters</code>.</p>
3503
3785
  */
3504
3786
  ec2TagSet?: EC2TagSet;
3505
3787
  /**
3788
+ * @public
3506
3789
  * <p> The target Amazon ECS services in the deployment group. This applies only to
3507
3790
  * deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name
3508
3791
  * pair using the format <code><clustername>:<servicename></code>. </p>
3509
3792
  */
3510
3793
  ecsServices?: ECSService[];
3511
3794
  /**
3795
+ * @public
3512
3796
  * <p>Information about groups of tags applied to on-premises instances. The deployment
3513
3797
  * group includes only on-premises instances identified by all of the tag groups. Cannot be
3514
3798
  * used in the same call as <code>onPremisesInstanceTagFilters</code>.</p>
3515
3799
  */
3516
3800
  onPremisesTagSet?: OnPremisesTagSet;
3517
3801
  /**
3802
+ * @public
3518
3803
  * <p> The metadata that you apply to CodeDeploy deployment groups to help you organize and
3519
3804
  * categorize them. Each tag consists of a key and an optional value, both of which you
3520
3805
  * define. </p>
@@ -3527,6 +3812,7 @@ export interface CreateDeploymentGroupInput {
3527
3812
  */
3528
3813
  export interface CreateDeploymentGroupOutput {
3529
3814
  /**
3815
+ * @public
3530
3816
  * <p>A unique deployment group ID.</p>
3531
3817
  */
3532
3818
  deploymentGroupId?: string;
@@ -3736,6 +4022,7 @@ export declare class TriggerTargetsLimitExceededException extends __BaseExceptio
3736
4022
  */
3737
4023
  export interface DeleteApplicationInput {
3738
4024
  /**
4025
+ * @public
3739
4026
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
3740
4027
  */
3741
4028
  applicationName: string | undefined;
@@ -3746,6 +4033,7 @@ export interface DeleteApplicationInput {
3746
4033
  */
3747
4034
  export interface DeleteDeploymentConfigInput {
3748
4035
  /**
4036
+ * @public
3749
4037
  * <p>The name of a deployment configuration associated with the IAM user or
3750
4038
  * Amazon Web Services account.</p>
3751
4039
  */
@@ -3781,10 +4069,12 @@ export declare class InvalidOperationException extends __BaseException {
3781
4069
  */
3782
4070
  export interface DeleteDeploymentGroupInput {
3783
4071
  /**
4072
+ * @public
3784
4073
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
3785
4074
  */
3786
4075
  applicationName: string | undefined;
3787
4076
  /**
4077
+ * @public
3788
4078
  * <p>The name of a deployment group for the specified application.</p>
3789
4079
  */
3790
4080
  deploymentGroupName: string | undefined;
@@ -3795,6 +4085,7 @@ export interface DeleteDeploymentGroupInput {
3795
4085
  */
3796
4086
  export interface DeleteDeploymentGroupOutput {
3797
4087
  /**
4088
+ * @public
3798
4089
  * <p>If the output contains no data, and the corresponding deployment group contained at
3799
4090
  * least one Auto Scaling group, CodeDeploy successfully removed all
3800
4091
  * corresponding Auto Scaling lifecycle event hooks from the Amazon EC2
@@ -3809,6 +4100,7 @@ export interface DeleteDeploymentGroupOutput {
3809
4100
  */
3810
4101
  export interface DeleteGitHubAccountTokenInput {
3811
4102
  /**
4103
+ * @public
3812
4104
  * <p>The name of the GitHub account connection to delete.</p>
3813
4105
  */
3814
4106
  tokenName?: string;
@@ -3819,6 +4111,7 @@ export interface DeleteGitHubAccountTokenInput {
3819
4111
  */
3820
4112
  export interface DeleteGitHubAccountTokenOutput {
3821
4113
  /**
4114
+ * @public
3822
4115
  * <p>The name of the GitHub account connection that was deleted.</p>
3823
4116
  */
3824
4117
  tokenName?: string;
@@ -3888,6 +4181,7 @@ export declare class ResourceValidationException extends __BaseException {
3888
4181
  */
3889
4182
  export interface DeleteResourcesByExternalIdInput {
3890
4183
  /**
4184
+ * @public
3891
4185
  * <p>The unique ID of an external resource (for example, a CloudFormation stack
3892
4186
  * ID) that is linked to one or more CodeDeploy resources.</p>
3893
4187
  */
@@ -3904,6 +4198,7 @@ export interface DeleteResourcesByExternalIdOutput {
3904
4198
  */
3905
4199
  export interface DeregisterOnPremisesInstanceInput {
3906
4200
  /**
4201
+ * @public
3907
4202
  * <p>The name of the on-premises instance to deregister.</p>
3908
4203
  */
3909
4204
  instanceName: string | undefined;
@@ -3914,6 +4209,7 @@ export interface DeregisterOnPremisesInstanceInput {
3914
4209
  */
3915
4210
  export interface GetApplicationInput {
3916
4211
  /**
4212
+ * @public
3917
4213
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
3918
4214
  */
3919
4215
  applicationName: string | undefined;
@@ -3924,6 +4220,7 @@ export interface GetApplicationInput {
3924
4220
  */
3925
4221
  export interface GetApplicationOutput {
3926
4222
  /**
4223
+ * @public
3927
4224
  * <p>Information about the application.</p>
3928
4225
  */
3929
4226
  application?: ApplicationInfo;
@@ -3934,10 +4231,12 @@ export interface GetApplicationOutput {
3934
4231
  */
3935
4232
  export interface GetApplicationRevisionInput {
3936
4233
  /**
4234
+ * @public
3937
4235
  * <p>The name of the application that corresponds to the revision.</p>
3938
4236
  */
3939
4237
  applicationName: string | undefined;
3940
4238
  /**
4239
+ * @public
3941
4240
  * <p>Information about the application revision to get, including type and location.</p>
3942
4241
  */
3943
4242
  revision: RevisionLocation | undefined;
@@ -3948,14 +4247,17 @@ export interface GetApplicationRevisionInput {
3948
4247
  */
3949
4248
  export interface GetApplicationRevisionOutput {
3950
4249
  /**
4250
+ * @public
3951
4251
  * <p>The name of the application that corresponds to the revision.</p>
3952
4252
  */
3953
4253
  applicationName?: string;
3954
4254
  /**
4255
+ * @public
3955
4256
  * <p>Additional information about the revision, including type and location.</p>
3956
4257
  */
3957
4258
  revision?: RevisionLocation;
3958
4259
  /**
4260
+ * @public
3959
4261
  * <p>General information about the revision.</p>
3960
4262
  */
3961
4263
  revisionInfo?: GenericRevisionInfo;
@@ -3966,6 +4268,7 @@ export interface GetApplicationRevisionOutput {
3966
4268
  */
3967
4269
  export interface GetDeploymentInput {
3968
4270
  /**
4271
+ * @public
3969
4272
  * <p> The unique ID of a deployment associated with the IAM user or Amazon Web Services account. </p>
3970
4273
  */
3971
4274
  deploymentId: string | undefined;
@@ -3976,6 +4279,7 @@ export interface GetDeploymentInput {
3976
4279
  */
3977
4280
  export interface GetDeploymentOutput {
3978
4281
  /**
4282
+ * @public
3979
4283
  * <p>Information about the deployment.</p>
3980
4284
  */
3981
4285
  deploymentInfo?: DeploymentInfo;
@@ -3986,6 +4290,7 @@ export interface GetDeploymentOutput {
3986
4290
  */
3987
4291
  export interface GetDeploymentConfigInput {
3988
4292
  /**
4293
+ * @public
3989
4294
  * <p>The name of a deployment configuration associated with the IAM user or
3990
4295
  * Amazon Web Services account.</p>
3991
4296
  */
@@ -3997,27 +4302,33 @@ export interface GetDeploymentConfigInput {
3997
4302
  */
3998
4303
  export interface DeploymentConfigInfo {
3999
4304
  /**
4305
+ * @public
4000
4306
  * <p>The deployment configuration ID.</p>
4001
4307
  */
4002
4308
  deploymentConfigId?: string;
4003
4309
  /**
4310
+ * @public
4004
4311
  * <p>The deployment configuration name.</p>
4005
4312
  */
4006
4313
  deploymentConfigName?: string;
4007
4314
  /**
4315
+ * @public
4008
4316
  * <p>Information about the number or percentage of minimum healthy instance.</p>
4009
4317
  */
4010
4318
  minimumHealthyHosts?: MinimumHealthyHosts;
4011
4319
  /**
4320
+ * @public
4012
4321
  * <p>The time at which the deployment configuration was created.</p>
4013
4322
  */
4014
4323
  createTime?: Date;
4015
4324
  /**
4325
+ * @public
4016
4326
  * <p>The destination platform type for the deployment (<code>Lambda</code>,
4017
4327
  * <code>Server</code>, or <code>ECS</code>).</p>
4018
4328
  */
4019
4329
  computePlatform?: ComputePlatform | string;
4020
4330
  /**
4331
+ * @public
4021
4332
  * <p>The configuration that specifies how the deployment traffic is routed. Used for
4022
4333
  * deployments with a Lambda or Amazon ECS compute platform
4023
4334
  * only.</p>
@@ -4030,6 +4341,7 @@ export interface DeploymentConfigInfo {
4030
4341
  */
4031
4342
  export interface GetDeploymentConfigOutput {
4032
4343
  /**
4344
+ * @public
4033
4345
  * <p>Information about the deployment configuration.</p>
4034
4346
  */
4035
4347
  deploymentConfigInfo?: DeploymentConfigInfo;
@@ -4040,10 +4352,12 @@ export interface GetDeploymentConfigOutput {
4040
4352
  */
4041
4353
  export interface GetDeploymentGroupInput {
4042
4354
  /**
4355
+ * @public
4043
4356
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
4044
4357
  */
4045
4358
  applicationName: string | undefined;
4046
4359
  /**
4360
+ * @public
4047
4361
  * <p>The name of a deployment group for the specified application.</p>
4048
4362
  */
4049
4363
  deploymentGroupName: string | undefined;
@@ -4054,6 +4368,7 @@ export interface GetDeploymentGroupInput {
4054
4368
  */
4055
4369
  export interface GetDeploymentGroupOutput {
4056
4370
  /**
4371
+ * @public
4057
4372
  * <p>Information about the deployment group.</p>
4058
4373
  */
4059
4374
  deploymentGroupInfo?: DeploymentGroupInfo;
@@ -4064,10 +4379,12 @@ export interface GetDeploymentGroupOutput {
4064
4379
  */
4065
4380
  export interface GetDeploymentInstanceInput {
4066
4381
  /**
4382
+ * @public
4067
4383
  * <p> The unique ID of a deployment. </p>
4068
4384
  */
4069
4385
  deploymentId: string | undefined;
4070
4386
  /**
4387
+ * @public
4071
4388
  * <p> The unique ID of an instance in the deployment group. </p>
4072
4389
  */
4073
4390
  instanceId: string | undefined;
@@ -4078,6 +4395,7 @@ export interface GetDeploymentInstanceInput {
4078
4395
  */
4079
4396
  export interface GetDeploymentInstanceOutput {
4080
4397
  /**
4398
+ * @public
4081
4399
  * @deprecated
4082
4400
  *
4083
4401
  * <p> Information about the instance. </p>
@@ -4089,10 +4407,12 @@ export interface GetDeploymentInstanceOutput {
4089
4407
  */
4090
4408
  export interface GetDeploymentTargetInput {
4091
4409
  /**
4410
+ * @public
4092
4411
  * <p> The unique ID of a deployment. </p>
4093
4412
  */
4094
4413
  deploymentId?: string;
4095
4414
  /**
4415
+ * @public
4096
4416
  * <p> The unique ID of a deployment target. </p>
4097
4417
  */
4098
4418
  targetId?: string;
@@ -4102,6 +4422,7 @@ export interface GetDeploymentTargetInput {
4102
4422
  */
4103
4423
  export interface GetDeploymentTargetOutput {
4104
4424
  /**
4425
+ * @public
4105
4426
  * <p> A deployment target that contains information about a deployment such as its status,
4106
4427
  * lifecycle events, and when it was last updated. It also contains metadata about the
4107
4428
  * deployment target. The deployment target metadata depends on the deployment target's
@@ -4116,6 +4437,7 @@ export interface GetDeploymentTargetOutput {
4116
4437
  */
4117
4438
  export interface GetOnPremisesInstanceInput {
4118
4439
  /**
4440
+ * @public
4119
4441
  * <p> The name of the on-premises instance about which to get information. </p>
4120
4442
  */
4121
4443
  instanceName: string | undefined;
@@ -4126,6 +4448,7 @@ export interface GetOnPremisesInstanceInput {
4126
4448
  */
4127
4449
  export interface GetOnPremisesInstanceOutput {
4128
4450
  /**
4451
+ * @public
4129
4452
  * <p> Information about the on-premises instance. </p>
4130
4453
  */
4131
4454
  instanceInfo?: InstanceInfo;
@@ -4234,10 +4557,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
4234
4557
  */
4235
4558
  export interface ListApplicationRevisionsInput {
4236
4559
  /**
4560
+ * @public
4237
4561
  * <p> The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account. </p>
4238
4562
  */
4239
4563
  applicationName: string | undefined;
4240
4564
  /**
4565
+ * @public
4241
4566
  * <p>The column name to use to sort the list results:</p>
4242
4567
  * <ul>
4243
4568
  * <li>
@@ -4261,6 +4586,7 @@ export interface ListApplicationRevisionsInput {
4261
4586
  */
4262
4587
  sortBy?: ApplicationRevisionSortBy | string;
4263
4588
  /**
4589
+ * @public
4264
4590
  * <p> The order in which to sort the list results: </p>
4265
4591
  * <ul>
4266
4592
  * <li>
@@ -4277,16 +4603,19 @@ export interface ListApplicationRevisionsInput {
4277
4603
  */
4278
4604
  sortOrder?: SortOrder | string;
4279
4605
  /**
4606
+ * @public
4280
4607
  * <p> An Amazon S3 bucket name to limit the search for revisions. </p>
4281
4608
  * <p> If set to null, all of the user's buckets are searched. </p>
4282
4609
  */
4283
4610
  s3Bucket?: string;
4284
4611
  /**
4612
+ * @public
4285
4613
  * <p> A key prefix for the set of Amazon S3 objects to limit the search for
4286
4614
  * revisions. </p>
4287
4615
  */
4288
4616
  s3KeyPrefix?: string;
4289
4617
  /**
4618
+ * @public
4290
4619
  * <p> Whether to list revisions based on whether the revision is the target revision of a
4291
4620
  * deployment group: </p>
4292
4621
  * <ul>
@@ -4308,6 +4637,7 @@ export interface ListApplicationRevisionsInput {
4308
4637
  */
4309
4638
  deployed?: ListStateFilterAction | string;
4310
4639
  /**
4640
+ * @public
4311
4641
  * <p>An identifier returned from the previous <code>ListApplicationRevisions</code> call.
4312
4642
  * It can be used to return the next set of applications in the list.</p>
4313
4643
  */
@@ -4319,10 +4649,12 @@ export interface ListApplicationRevisionsInput {
4319
4649
  */
4320
4650
  export interface ListApplicationRevisionsOutput {
4321
4651
  /**
4652
+ * @public
4322
4653
  * <p>A list of locations that contain the matching revisions.</p>
4323
4654
  */
4324
4655
  revisions?: RevisionLocation[];
4325
4656
  /**
4657
+ * @public
4326
4658
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4327
4659
  * be used in a subsequent list application revisions call to return the next set of
4328
4660
  * application revisions in the list.</p>
@@ -4335,6 +4667,7 @@ export interface ListApplicationRevisionsOutput {
4335
4667
  */
4336
4668
  export interface ListApplicationsInput {
4337
4669
  /**
4670
+ * @public
4338
4671
  * <p>An identifier returned from the previous list applications call. It can be used to
4339
4672
  * return the next set of applications in the list.</p>
4340
4673
  */
@@ -4346,10 +4679,12 @@ export interface ListApplicationsInput {
4346
4679
  */
4347
4680
  export interface ListApplicationsOutput {
4348
4681
  /**
4682
+ * @public
4349
4683
  * <p>A list of application names.</p>
4350
4684
  */
4351
4685
  applications?: string[];
4352
4686
  /**
4687
+ * @public
4353
4688
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4354
4689
  * be used in a subsequent list applications call to return the next set of applications in
4355
4690
  * the list.</p>
@@ -4362,6 +4697,7 @@ export interface ListApplicationsOutput {
4362
4697
  */
4363
4698
  export interface ListDeploymentConfigsInput {
4364
4699
  /**
4700
+ * @public
4365
4701
  * <p>An identifier returned from the previous <code>ListDeploymentConfigs</code> call. It
4366
4702
  * can be used to return the next set of deployment configurations in the list. </p>
4367
4703
  */
@@ -4373,11 +4709,13 @@ export interface ListDeploymentConfigsInput {
4373
4709
  */
4374
4710
  export interface ListDeploymentConfigsOutput {
4375
4711
  /**
4712
+ * @public
4376
4713
  * <p>A list of deployment configurations, including built-in configurations such as
4377
4714
  * <code>CodeDeployDefault.OneAtATime</code>.</p>
4378
4715
  */
4379
4716
  deploymentConfigsList?: string[];
4380
4717
  /**
4718
+ * @public
4381
4719
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4382
4720
  * be used in a subsequent list deployment configurations call to return the next set of
4383
4721
  * deployment configurations in the list.</p>
@@ -4390,10 +4728,12 @@ export interface ListDeploymentConfigsOutput {
4390
4728
  */
4391
4729
  export interface ListDeploymentGroupsInput {
4392
4730
  /**
4731
+ * @public
4393
4732
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
4394
4733
  */
4395
4734
  applicationName: string | undefined;
4396
4735
  /**
4736
+ * @public
4397
4737
  * <p>An identifier returned from the previous list deployment groups call. It can be used
4398
4738
  * to return the next set of deployment groups in the list.</p>
4399
4739
  */
@@ -4405,14 +4745,17 @@ export interface ListDeploymentGroupsInput {
4405
4745
  */
4406
4746
  export interface ListDeploymentGroupsOutput {
4407
4747
  /**
4748
+ * @public
4408
4749
  * <p>The application name.</p>
4409
4750
  */
4410
4751
  applicationName?: string;
4411
4752
  /**
4753
+ * @public
4412
4754
  * <p>A list of deployment group names.</p>
4413
4755
  */
4414
4756
  deploymentGroups?: string[];
4415
4757
  /**
4758
+ * @public
4416
4759
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4417
4760
  * be used in a subsequent list deployment groups call to return the next set of deployment
4418
4761
  * groups in the list.</p>
@@ -4476,15 +4819,18 @@ export declare class InvalidTargetFilterNameException extends __BaseException {
4476
4819
  */
4477
4820
  export interface ListDeploymentInstancesInput {
4478
4821
  /**
4822
+ * @public
4479
4823
  * <p> The unique ID of a deployment. </p>
4480
4824
  */
4481
4825
  deploymentId: string | undefined;
4482
4826
  /**
4827
+ * @public
4483
4828
  * <p>An identifier returned from the previous list deployment instances call. It can be
4484
4829
  * used to return the next set of deployment instances in the list.</p>
4485
4830
  */
4486
4831
  nextToken?: string;
4487
4832
  /**
4833
+ * @public
4488
4834
  * <p>A subset of instances to list by status:</p>
4489
4835
  * <ul>
4490
4836
  * <li>
@@ -4518,6 +4864,7 @@ export interface ListDeploymentInstancesInput {
4518
4864
  */
4519
4865
  instanceStatusFilter?: (InstanceStatus | string)[];
4520
4866
  /**
4867
+ * @public
4521
4868
  * <p>The set of instances in a blue/green deployment, either those in the original
4522
4869
  * environment ("BLUE") or those in the replacement environment ("GREEN"), for which you
4523
4870
  * want to view instance information.</p>
@@ -4530,10 +4877,12 @@ export interface ListDeploymentInstancesInput {
4530
4877
  */
4531
4878
  export interface ListDeploymentInstancesOutput {
4532
4879
  /**
4880
+ * @public
4533
4881
  * <p>A list of instance IDs.</p>
4534
4882
  */
4535
4883
  instancesList?: string[];
4536
4884
  /**
4885
+ * @public
4537
4886
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4538
4887
  * be used in a subsequent list deployment instances call to return the next set of
4539
4888
  * deployment instances in the list.</p>
@@ -4570,6 +4919,7 @@ export declare class InvalidTimeRangeException extends __BaseException {
4570
4919
  */
4571
4920
  export interface TimeRange {
4572
4921
  /**
4922
+ * @public
4573
4923
  * <p>The start time of the time range.</p>
4574
4924
  * <note>
4575
4925
  * <p>Specify null to leave the start time open-ended.</p>
@@ -4577,6 +4927,7 @@ export interface TimeRange {
4577
4927
  */
4578
4928
  start?: Date;
4579
4929
  /**
4930
+ * @public
4580
4931
  * <p>The end time of the time range.</p>
4581
4932
  * <note>
4582
4933
  * <p>Specify null to leave the end time open-ended.</p>
@@ -4590,6 +4941,7 @@ export interface TimeRange {
4590
4941
  */
4591
4942
  export interface ListDeploymentsInput {
4592
4943
  /**
4944
+ * @public
4593
4945
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
4594
4946
  * <note>
4595
4947
  * <p>If <code>applicationName</code> is specified, then
@@ -4599,6 +4951,7 @@ export interface ListDeploymentsInput {
4599
4951
  */
4600
4952
  applicationName?: string;
4601
4953
  /**
4954
+ * @public
4602
4955
  * <p>The name of a deployment group for the specified application.</p>
4603
4956
  * <note>
4604
4957
  * <p>If <code>deploymentGroupName</code> is specified, then
@@ -4608,11 +4961,13 @@ export interface ListDeploymentsInput {
4608
4961
  */
4609
4962
  deploymentGroupName?: string;
4610
4963
  /**
4964
+ * @public
4611
4965
  * <p>The unique ID of an external resource for returning deployments linked to the external
4612
4966
  * resource.</p>
4613
4967
  */
4614
4968
  externalId?: string;
4615
4969
  /**
4970
+ * @public
4616
4971
  * <p>A subset of deployments to list by status:</p>
4617
4972
  * <ul>
4618
4973
  * <li>
@@ -4647,10 +5002,12 @@ export interface ListDeploymentsInput {
4647
5002
  */
4648
5003
  includeOnlyStatuses?: (DeploymentStatus | string)[];
4649
5004
  /**
5005
+ * @public
4650
5006
  * <p>A time range (start and end) for returning a subset of the list of deployments.</p>
4651
5007
  */
4652
5008
  createTimeRange?: TimeRange;
4653
5009
  /**
5010
+ * @public
4654
5011
  * <p>An identifier returned from the previous list deployments call. It can be used to
4655
5012
  * return the next set of deployments in the list.</p>
4656
5013
  */
@@ -4662,10 +5019,12 @@ export interface ListDeploymentsInput {
4662
5019
  */
4663
5020
  export interface ListDeploymentsOutput {
4664
5021
  /**
5022
+ * @public
4665
5023
  * <p>A list of deployment IDs.</p>
4666
5024
  */
4667
5025
  deployments?: string[];
4668
5026
  /**
5027
+ * @public
4669
5028
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4670
5029
  * be used in a subsequent list deployments call to return the next set of deployments in
4671
5030
  * the list.</p>
@@ -4689,15 +5048,18 @@ export type TargetFilterName = (typeof TargetFilterName)[keyof typeof TargetFilt
4689
5048
  */
4690
5049
  export interface ListDeploymentTargetsInput {
4691
5050
  /**
5051
+ * @public
4692
5052
  * <p> The unique ID of a deployment. </p>
4693
5053
  */
4694
5054
  deploymentId?: string;
4695
5055
  /**
5056
+ * @public
4696
5057
  * <p> A token identifier returned from the previous <code>ListDeploymentTargets</code>
4697
5058
  * call. It can be used to return the next set of deployment targets in the list. </p>
4698
5059
  */
4699
5060
  nextToken?: string;
4700
5061
  /**
5062
+ * @public
4701
5063
  * <p> A key used to filter the returned targets. The two valid values are:</p>
4702
5064
  * <ul>
4703
5065
  * <li>
@@ -4721,10 +5083,12 @@ export interface ListDeploymentTargetsInput {
4721
5083
  */
4722
5084
  export interface ListDeploymentTargetsOutput {
4723
5085
  /**
5086
+ * @public
4724
5087
  * <p> The unique IDs of deployment targets. </p>
4725
5088
  */
4726
5089
  targetIds?: string[];
4727
5090
  /**
5091
+ * @public
4728
5092
  * <p> If a large amount of information is returned, a token identifier is also returned. It
4729
5093
  * can be used in a subsequent <code>ListDeploymentTargets</code> call to return the next
4730
5094
  * set of deployment targets in the list. </p>
@@ -4737,6 +5101,7 @@ export interface ListDeploymentTargetsOutput {
4737
5101
  */
4738
5102
  export interface ListGitHubAccountTokenNamesInput {
4739
5103
  /**
5104
+ * @public
4740
5105
  * <p>An identifier returned from the previous <code>ListGitHubAccountTokenNames</code>
4741
5106
  * call. It can be used to return the next set of names in the list. </p>
4742
5107
  */
@@ -4748,10 +5113,12 @@ export interface ListGitHubAccountTokenNamesInput {
4748
5113
  */
4749
5114
  export interface ListGitHubAccountTokenNamesOutput {
4750
5115
  /**
5116
+ * @public
4751
5117
  * <p>A list of names of connections to GitHub accounts.</p>
4752
5118
  */
4753
5119
  tokenNameList?: string[];
4754
5120
  /**
5121
+ * @public
4755
5122
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4756
5123
  * be used in a subsequent <code>ListGitHubAccountTokenNames</code> call to return the next
4757
5124
  * set of names in the list. </p>
@@ -4800,6 +5167,7 @@ export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof Regist
4800
5167
  */
4801
5168
  export interface ListOnPremisesInstancesInput {
4802
5169
  /**
5170
+ * @public
4803
5171
  * <p>The registration status of the on-premises instances:</p>
4804
5172
  * <ul>
4805
5173
  * <li>
@@ -4816,11 +5184,13 @@ export interface ListOnPremisesInstancesInput {
4816
5184
  */
4817
5185
  registrationStatus?: RegistrationStatus | string;
4818
5186
  /**
5187
+ * @public
4819
5188
  * <p>The on-premises instance tags that are used to restrict the on-premises instance names
4820
5189
  * returned.</p>
4821
5190
  */
4822
5191
  tagFilters?: TagFilter[];
4823
5192
  /**
5193
+ * @public
4824
5194
  * <p>An identifier returned from the previous list on-premises instances call. It can be
4825
5195
  * used to return the next set of on-premises instances in the list.</p>
4826
5196
  */
@@ -4832,10 +5202,12 @@ export interface ListOnPremisesInstancesInput {
4832
5202
  */
4833
5203
  export interface ListOnPremisesInstancesOutput {
4834
5204
  /**
5205
+ * @public
4835
5206
  * <p>The list of matching on-premises instance names.</p>
4836
5207
  */
4837
5208
  instanceNames?: string[];
4838
5209
  /**
5210
+ * @public
4839
5211
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4840
5212
  * be used in a subsequent list on-premises instances call to return the next set of
4841
5213
  * on-premises instances in the list.</p>
@@ -4859,12 +5231,14 @@ export declare class InvalidArnException extends __BaseException {
4859
5231
  */
4860
5232
  export interface ListTagsForResourceInput {
4861
5233
  /**
5234
+ * @public
4862
5235
  * <p> The ARN of a CodeDeploy resource. <code>ListTagsForResource</code> returns all the
4863
5236
  * tags associated with the resource that is identified by the <code>ResourceArn</code>.
4864
5237
  * </p>
4865
5238
  */
4866
5239
  ResourceArn: string | undefined;
4867
5240
  /**
5241
+ * @public
4868
5242
  * <p>An identifier returned from the previous <code>ListTagsForResource</code> call. It can
4869
5243
  * be used to return the next set of applications in the list.</p>
4870
5244
  */
@@ -4875,11 +5249,13 @@ export interface ListTagsForResourceInput {
4875
5249
  */
4876
5250
  export interface ListTagsForResourceOutput {
4877
5251
  /**
5252
+ * @public
4878
5253
  * <p> A list of tags returned by <code>ListTagsForResource</code>. The tags are associated
4879
5254
  * with the resource identified by the input <code>ResourceArn</code> parameter. </p>
4880
5255
  */
4881
5256
  Tags?: Tag[];
4882
5257
  /**
5258
+ * @public
4883
5259
  * <p>If a large amount of information is returned, an identifier is also returned. It can
4884
5260
  * be used in a subsequent list application revisions call to return the next set of
4885
5261
  * application revisions in the list.</p>
@@ -4943,16 +5319,19 @@ export declare class LifecycleEventAlreadyCompletedException extends __BaseExcep
4943
5319
  */
4944
5320
  export interface PutLifecycleEventHookExecutionStatusInput {
4945
5321
  /**
5322
+ * @public
4946
5323
  * <p> The unique ID of a deployment. Pass this ID to a Lambda function that
4947
5324
  * validates a deployment lifecycle event. </p>
4948
5325
  */
4949
5326
  deploymentId?: string;
4950
5327
  /**
5328
+ * @public
4951
5329
  * <p> The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is
4952
5330
  * specified in the <code>hooks</code> section of the AppSpec file. </p>
4953
5331
  */
4954
5332
  lifecycleEventHookExecutionId?: string;
4955
5333
  /**
5334
+ * @public
4956
5335
  * <p>The result of a Lambda function that validates a deployment lifecycle
4957
5336
  * event. The values listed in <b>Valid Values</b> are valid for
4958
5337
  * lifecycle statuses in general; however, only <code>Succeeded</code> and
@@ -4965,6 +5344,7 @@ export interface PutLifecycleEventHookExecutionStatusInput {
4965
5344
  */
4966
5345
  export interface PutLifecycleEventHookExecutionStatusOutput {
4967
5346
  /**
5347
+ * @public
4968
5348
  * <p>The execution ID of the lifecycle event hook. A hook is specified in the
4969
5349
  * <code>hooks</code> section of the deployment's AppSpec file.</p>
4970
5350
  */
@@ -4976,14 +5356,17 @@ export interface PutLifecycleEventHookExecutionStatusOutput {
4976
5356
  */
4977
5357
  export interface RegisterApplicationRevisionInput {
4978
5358
  /**
5359
+ * @public
4979
5360
  * <p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>
4980
5361
  */
4981
5362
  applicationName: string | undefined;
4982
5363
  /**
5364
+ * @public
4983
5365
  * <p>A comment about the revision.</p>
4984
5366
  */
4985
5367
  description?: string;
4986
5368
  /**
5369
+ * @public
4987
5370
  * <p>Information about the application revision to register, including type and
4988
5371
  * location.</p>
4989
5372
  */
@@ -5094,15 +5477,18 @@ export declare class MultipleIamArnsProvidedException extends __BaseException {
5094
5477
  */
5095
5478
  export interface RegisterOnPremisesInstanceInput {
5096
5479
  /**
5480
+ * @public
5097
5481
  * <p>The name of the on-premises instance to register.</p>
5098
5482
  */
5099
5483
  instanceName: string | undefined;
5100
5484
  /**
5485
+ * @public
5101
5486
  * <p>The ARN of the IAM session to associate with the on-premises
5102
5487
  * instance.</p>
5103
5488
  */
5104
5489
  iamSessionArn?: string;
5105
5490
  /**
5491
+ * @public
5106
5492
  * <p>The ARN of the IAM user to associate with the on-premises
5107
5493
  * instance.</p>
5108
5494
  */
@@ -5115,10 +5501,12 @@ export interface RegisterOnPremisesInstanceInput {
5115
5501
  */
5116
5502
  export interface RemoveTagsFromOnPremisesInstancesInput {
5117
5503
  /**
5504
+ * @public
5118
5505
  * <p>The tag key-value pairs to remove from the on-premises instances.</p>
5119
5506
  */
5120
5507
  tags: Tag[] | undefined;
5121
5508
  /**
5509
+ * @public
5122
5510
  * <p>The names of the on-premises instances from which to remove tags.</p>
5123
5511
  */
5124
5512
  instanceNames: string[] | undefined;
@@ -5128,6 +5516,7 @@ export interface RemoveTagsFromOnPremisesInstancesInput {
5128
5516
  */
5129
5517
  export interface SkipWaitTimeForInstanceTerminationInput {
5130
5518
  /**
5519
+ * @public
5131
5520
  * <p> The unique ID of a blue/green deployment for which you want to skip the instance
5132
5521
  * termination wait time. </p>
5133
5522
  */
@@ -5139,10 +5528,12 @@ export interface SkipWaitTimeForInstanceTerminationInput {
5139
5528
  */
5140
5529
  export interface StopDeploymentInput {
5141
5530
  /**
5531
+ * @public
5142
5532
  * <p> The unique ID of a deployment. </p>
5143
5533
  */
5144
5534
  deploymentId: string | undefined;
5145
5535
  /**
5536
+ * @public
5146
5537
  * <p> Indicates, when a deployment is stopped, whether instances that have been updated
5147
5538
  * should be rolled back to the previous version of the application revision. </p>
5148
5539
  */
@@ -5166,6 +5557,7 @@ export type StopStatus = (typeof StopStatus)[keyof typeof StopStatus];
5166
5557
  */
5167
5558
  export interface StopDeploymentOutput {
5168
5559
  /**
5560
+ * @public
5169
5561
  * <p>The status of the stop deployment operation:</p>
5170
5562
  * <ul>
5171
5563
  * <li>
@@ -5178,6 +5570,7 @@ export interface StopDeploymentOutput {
5178
5570
  */
5179
5571
  status?: StopStatus | string;
5180
5572
  /**
5573
+ * @public
5181
5574
  * <p>An accompanying status message.</p>
5182
5575
  */
5183
5576
  statusMessage?: string;
@@ -5187,10 +5580,12 @@ export interface StopDeploymentOutput {
5187
5580
  */
5188
5581
  export interface TagResourceInput {
5189
5582
  /**
5583
+ * @public
5190
5584
  * <p> The ARN of a resource, such as a CodeDeploy application or deployment group. </p>
5191
5585
  */
5192
5586
  ResourceArn: string | undefined;
5193
5587
  /**
5588
+ * @public
5194
5589
  * <p> A list of tags that <code>TagResource</code> associates with a resource. The resource
5195
5590
  * is identified by the <code>ResourceArn</code> input parameter. </p>
5196
5591
  */
@@ -5206,11 +5601,13 @@ export interface TagResourceOutput {
5206
5601
  */
5207
5602
  export interface UntagResourceInput {
5208
5603
  /**
5604
+ * @public
5209
5605
  * <p> The Amazon Resource Name (ARN) that specifies from which resource to disassociate the
5210
5606
  * tags with the keys in the <code>TagKeys</code> input parameter. </p>
5211
5607
  */
5212
5608
  ResourceArn: string | undefined;
5213
5609
  /**
5610
+ * @public
5214
5611
  * <p> A list of keys of <code>Tag</code> objects. The <code>Tag</code> objects identified
5215
5612
  * by the keys are disassociated from the resource specified by the
5216
5613
  * <code>ResourceArn</code> input parameter. </p>
@@ -5228,10 +5625,12 @@ export interface UntagResourceOutput {
5228
5625
  */
5229
5626
  export interface UpdateApplicationInput {
5230
5627
  /**
5628
+ * @public
5231
5629
  * <p>The current name of the application you want to change.</p>
5232
5630
  */
5233
5631
  applicationName?: string;
5234
5632
  /**
5633
+ * @public
5235
5634
  * <p>The new name to give the application.</p>
5236
5635
  */
5237
5636
  newApplicationName?: string;
@@ -5242,34 +5641,41 @@ export interface UpdateApplicationInput {
5242
5641
  */
5243
5642
  export interface UpdateDeploymentGroupInput {
5244
5643
  /**
5644
+ * @public
5245
5645
  * <p>The application name that corresponds to the deployment group to update.</p>
5246
5646
  */
5247
5647
  applicationName: string | undefined;
5248
5648
  /**
5649
+ * @public
5249
5650
  * <p>The current name of the deployment group.</p>
5250
5651
  */
5251
5652
  currentDeploymentGroupName: string | undefined;
5252
5653
  /**
5654
+ * @public
5253
5655
  * <p>The new name of the deployment group, if you want to change it.</p>
5254
5656
  */
5255
5657
  newDeploymentGroupName?: string;
5256
5658
  /**
5659
+ * @public
5257
5660
  * <p>The replacement deployment configuration name to use, if you want to change it.</p>
5258
5661
  */
5259
5662
  deploymentConfigName?: string;
5260
5663
  /**
5664
+ * @public
5261
5665
  * <p>The replacement set of Amazon EC2 tags on which to filter, if you want to
5262
5666
  * change them. To keep the existing tags, enter their names. To remove tags, do not enter
5263
5667
  * any tag names.</p>
5264
5668
  */
5265
5669
  ec2TagFilters?: EC2TagFilter[];
5266
5670
  /**
5671
+ * @public
5267
5672
  * <p>The replacement set of on-premises instance tags on which to filter, if you want to
5268
5673
  * change them. To keep the existing tags, enter their names. To remove tags, do not enter
5269
5674
  * any tag names.</p>
5270
5675
  */
5271
5676
  onPremisesInstanceTagFilters?: TagFilter[];
5272
5677
  /**
5678
+ * @public
5273
5679
  * <p>The replacement list of Auto Scaling groups to be included in the deployment
5274
5680
  * group, if you want to change them.</p>
5275
5681
  * <ul>
@@ -5286,10 +5692,12 @@ export interface UpdateDeploymentGroupInput {
5286
5692
  */
5287
5693
  autoScalingGroups?: string[];
5288
5694
  /**
5695
+ * @public
5289
5696
  * <p>A replacement ARN for the service role, if you want to change it.</p>
5290
5697
  */
5291
5698
  serviceRoleArn?: string;
5292
5699
  /**
5700
+ * @public
5293
5701
  * <p>Information about triggers to change when the deployment group is updated. For
5294
5702
  * examples, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html">Edit a Trigger in a
5295
5703
  * CodeDeploy Deployment Group</a> in the <i>CodeDeploy User
@@ -5297,16 +5705,19 @@ export interface UpdateDeploymentGroupInput {
5297
5705
  */
5298
5706
  triggerConfigurations?: TriggerConfig[];
5299
5707
  /**
5708
+ * @public
5300
5709
  * <p>Information to add or change about Amazon CloudWatch alarms when the deployment group
5301
5710
  * is updated.</p>
5302
5711
  */
5303
5712
  alarmConfiguration?: AlarmConfiguration;
5304
5713
  /**
5714
+ * @public
5305
5715
  * <p>Information for an automatic rollback configuration that is added or changed when a
5306
5716
  * deployment group is updated.</p>
5307
5717
  */
5308
5718
  autoRollbackConfiguration?: AutoRollbackConfiguration;
5309
5719
  /**
5720
+ * @public
5310
5721
  * <p>Indicates what happens when new Amazon EC2 instances are launched
5311
5722
  * mid-deployment and do not receive the deployed application revision.</p>
5312
5723
  * <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates
@@ -5318,31 +5729,37 @@ export interface UpdateDeploymentGroupInput {
5318
5729
  */
5319
5730
  outdatedInstancesStrategy?: OutdatedInstancesStrategy | string;
5320
5731
  /**
5732
+ * @public
5321
5733
  * <p>Information about the type of deployment, either in-place or blue/green, you want to
5322
5734
  * run and whether to route deployment traffic behind a load balancer.</p>
5323
5735
  */
5324
5736
  deploymentStyle?: DeploymentStyle;
5325
5737
  /**
5738
+ * @public
5326
5739
  * <p>Information about blue/green deployment options for a deployment group.</p>
5327
5740
  */
5328
5741
  blueGreenDeploymentConfiguration?: BlueGreenDeploymentConfiguration;
5329
5742
  /**
5743
+ * @public
5330
5744
  * <p>Information about the load balancer used in a deployment.</p>
5331
5745
  */
5332
5746
  loadBalancerInfo?: LoadBalancerInfo;
5333
5747
  /**
5748
+ * @public
5334
5749
  * <p>Information about groups of tags applied to on-premises instances. The deployment
5335
5750
  * group includes only Amazon EC2 instances identified by all the tag
5336
5751
  * groups.</p>
5337
5752
  */
5338
5753
  ec2TagSet?: EC2TagSet;
5339
5754
  /**
5755
+ * @public
5340
5756
  * <p> The target Amazon ECS services in the deployment group. This applies only to
5341
5757
  * deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name
5342
5758
  * pair using the format <code><clustername>:<servicename></code>. </p>
5343
5759
  */
5344
5760
  ecsServices?: ECSService[];
5345
5761
  /**
5762
+ * @public
5346
5763
  * <p>Information about an on-premises instance tag set. The deployment group includes only
5347
5764
  * on-premises instances identified by all the tag groups.</p>
5348
5765
  */
@@ -5354,6 +5771,7 @@ export interface UpdateDeploymentGroupInput {
5354
5771
  */
5355
5772
  export interface UpdateDeploymentGroupOutput {
5356
5773
  /**
5774
+ * @public
5357
5775
  * <p>If the output contains no data, and the corresponding deployment group contained at
5358
5776
  * least one Auto Scaling group, CodeDeploy successfully removed all
5359
5777
  * corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.</p>