-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
2465 lines (2465 loc) · 151 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.</p> <p>CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.</p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.</p> <p> <b>CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/codedeploy/latest/userguide\">CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/codedeploy/latest/APIReference/\">CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">CLI Reference for CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">CodeDeploy Developer Forum</a> </p> </li> </ul>",
"operations": {
"AddTagsToOnPremisesInstances": "<p>Adds tags to on-premises instances.</p>",
"BatchGetApplicationRevisions": "<p>Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.</p>",
"BatchGetApplications": "<p>Gets information about one or more applications. The maximum number of applications that can be returned is 100.</p>",
"BatchGetDeploymentGroups": "<p>Gets information about one or more deployment groups.</p>",
"BatchGetDeploymentInstances": "<note> <p> This method works, but is deprecated. Use <code>BatchGetDeploymentTargets</code> instead. </p> </note> <p> Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer <code>BatchGetDeploymentTargets</code> works with all compute platforms. The maximum number of instances that can be returned is 25.</p>",
"BatchGetDeploymentTargets": "<p> Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated <code>BatchGetDeploymentInstances</code>. The maximum number of targets that can be returned is 25.</p> <p> The type of targets returned depends on the deployment's compute platform or deployment method: </p> <ul> <li> <p> <b>EC2/On-premises</b>: Information about Amazon EC2 instance targets. </p> </li> <li> <p> <b>Lambda</b>: Information about Lambda functions targets. </p> </li> <li> <p> <b>Amazon ECS</b>: Information about Amazon ECS service targets. </p> </li> <li> <p> <b>CloudFormation</b>: Information about targets of blue/green deployments initiated by a CloudFormation stack update.</p> </li> </ul>",
"BatchGetDeployments": "<p>Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.</p>",
"BatchGetOnPremisesInstances": "<p>Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.</p>",
"ContinueDeployment": "<p>For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.) </p>",
"CreateApplication": "<p>Creates an application.</p>",
"CreateDeployment": "<p>Deploys an application revision through the specified deployment group.</p>",
"CreateDeploymentConfig": "<p> Creates a deployment configuration. </p>",
"CreateDeploymentGroup": "<p>Creates a deployment group to which application revisions are deployed.</p>",
"DeleteApplication": "<p>Deletes an application.</p>",
"DeleteDeploymentConfig": "<p>Deletes a deployment configuration.</p> <note> <p>A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.</p> </note>",
"DeleteDeploymentGroup": "<p>Deletes a deployment group.</p>",
"DeleteGitHubAccountToken": "<p>Deletes a GitHub account connection.</p>",
"DeleteResourcesByExternalId": "<p>Deletes resources linked to an external ID.</p>",
"DeregisterOnPremisesInstance": "<p>Deregisters an on-premises instance.</p>",
"GetApplication": "<p>Gets information about an application.</p>",
"GetApplicationRevision": "<p>Gets information about an application revision.</p>",
"GetDeployment": "<p>Gets information about a deployment.</p> <note> <p> The <code>content</code> property of the <code>appSpecContent</code> object in the returned revision is always null. Use <code>GetApplicationRevision</code> and the <code>sha256</code> property of the returned <code>appSpecContent</code> object to get the content of the deployment’s AppSpec file. </p> </note>",
"GetDeploymentConfig": "<p>Gets information about a deployment configuration.</p>",
"GetDeploymentGroup": "<p>Gets information about a deployment group.</p>",
"GetDeploymentInstance": "<p>Gets information about an instance as part of a deployment.</p>",
"GetDeploymentTarget": "<p> Returns information about a deployment target. </p>",
"GetOnPremisesInstance": "<p> Gets information about an on-premises instance. </p>",
"ListApplicationRevisions": "<p>Lists information about revisions for an application.</p>",
"ListApplications": "<p>Lists the applications registered with the IAM user or Amazon Web Services account.</p>",
"ListDeploymentConfigs": "<p>Lists the deployment configurations with the IAM user or Amazon Web Services account.</p>",
"ListDeploymentGroups": "<p>Lists the deployment groups for an application registered with the IAM user or Amazon Web Services account.</p>",
"ListDeploymentInstances": "<note> <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because it works with all compute types. <code>ListDeploymentInstances</code> throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda. </p> </note> <p> Lists the instance for a deployment associated with the IAM user or Amazon Web Services account. </p>",
"ListDeploymentTargets": "<p> Returns an array of target IDs that are associated a deployment. </p>",
"ListDeployments": "<p>Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.</p>",
"ListGitHubAccountTokenNames": "<p>Lists the names of stored connections to GitHub accounts.</p>",
"ListOnPremisesInstances": "<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.</p>",
"ListTagsForResource": "<p> Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources. </p>",
"PutLifecycleEventHookExecutionStatus": "<p> Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are <code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>. For Amazon ECS deployments, the available lifecycle hooks are <code>BeforeInstall</code>, <code>AfterInstall</code>, <code>AfterAllowTestTraffic</code>, <code>BeforeAllowTraffic</code>, and <code>AfterAllowTraffic</code>. Lambda validation functions return <code>Succeeded</code> or <code>Failed</code>. For more information, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda\">AppSpec 'hooks' Section for an Lambda Deployment </a> and <a href=\"https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs\">AppSpec 'hooks' Section for an Amazon ECS Deployment</a>.</p>",
"RegisterApplicationRevision": "<p>Registers with CodeDeploy a revision for the specified application.</p>",
"RegisterOnPremisesInstance": "<p>Registers an on-premises instance.</p> <note> <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p> </note>",
"RemoveTagsFromOnPremisesInstances": "<p>Removes one or more tags from one or more on-premises instances.</p>",
"SkipWaitTimeForInstanceTermination": "<p>In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.</p>",
"StopDeployment": "<p>Attempts to stop an ongoing deployment.</p>",
"TagResource": "<p> Associates the list of tags in the input <code>Tags</code> parameter with the resource identified by the <code>ResourceArn</code> input parameter. </p>",
"UntagResource": "<p> Disassociates a resource from a list of tags. The resource is identified by the <code>ResourceArn</code> input parameter. The tags are identified by the list of keys in the <code>TagKeys</code> input parameter. </p>",
"UpdateApplication": "<p>Changes the name of an application.</p>",
"UpdateDeploymentGroup": "<p>Changes information about a deployment group.</p>"
},
"shapes": {
"AddTagsToOnPremisesInstancesInput": {
"base": "<p>Represents the input of, and adds tags to, an on-premises instance operation.</p>",
"refs": {
}
},
"AdditionalDeploymentStatusInfo": {
"base": null,
"refs": {
"DeploymentInfo$additionalDeploymentStatusInfo": "<p>Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.</p>"
}
},
"Alarm": {
"base": "<p>Information about an alarm.</p>",
"refs": {
"AlarmList$member": null
}
},
"AlarmConfiguration": {
"base": "<p>Information about alarms associated with a deployment or deployment group.</p>",
"refs": {
"CreateDeploymentGroupInput$alarmConfiguration": "<p>Information to add about Amazon CloudWatch alarms when the deployment group is created.</p>",
"CreateDeploymentInput$overrideAlarmConfiguration": "<p>Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call <code>CreateDeployment</code> to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.</p> <note> <p>If you specify an <code>overrideAlarmConfiguration</code>, you need the <code>UpdateDeploymentGroup</code> IAM permission when calling <code>CreateDeployment</code>.</p> </note>",
"DeploymentGroupInfo$alarmConfiguration": "<p>A list of alarms associated with the deployment group.</p>",
"DeploymentInfo$overrideAlarmConfiguration": null,
"UpdateDeploymentGroupInput$alarmConfiguration": "<p>Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.</p>"
}
},
"AlarmList": {
"base": null,
"refs": {
"AlarmConfiguration$alarms": "<p>A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.</p>"
}
},
"AlarmName": {
"base": null,
"refs": {
"Alarm$name": "<p>The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.</p>"
}
},
"AlarmsLimitExceededException": {
"base": "<p>The maximum number of alarms for a deployment group (10) was exceeded.</p>",
"refs": {
}
},
"AppSpecContent": {
"base": "<p> A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated <code>RawString</code> data type. </p>",
"refs": {
"RevisionLocation$appSpecContent": "<p> The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString. </p>"
}
},
"ApplicationAlreadyExistsException": {
"base": "<p>An application with the specified name with the IAM user or Amazon Web Services account already exists.</p>",
"refs": {
}
},
"ApplicationDoesNotExistException": {
"base": "<p>The application does not exist with the IAM user or Amazon Web Services account.</p>",
"refs": {
}
},
"ApplicationId": {
"base": null,
"refs": {
"ApplicationInfo$applicationId": "<p>The application ID.</p>",
"CreateApplicationOutput$applicationId": "<p>A unique application ID.</p>"
}
},
"ApplicationInfo": {
"base": "<p>Information about an application.</p>",
"refs": {
"ApplicationsInfoList$member": null,
"GetApplicationOutput$application": "<p>Information about the application.</p>"
}
},
"ApplicationLimitExceededException": {
"base": "<p>More applications were attempted to be created than are allowed.</p>",
"refs": {
}
},
"ApplicationName": {
"base": null,
"refs": {
"ApplicationInfo$applicationName": "<p>The application name.</p>",
"ApplicationsList$member": null,
"BatchGetApplicationRevisionsInput$applicationName": "<p>The name of an CodeDeploy application about which to get revision information.</p>",
"BatchGetApplicationRevisionsOutput$applicationName": "<p>The name of the application that corresponds to the revisions.</p>",
"BatchGetDeploymentGroupsInput$applicationName": "<p>The name of an CodeDeploy application associated with the applicable IAM or Amazon Web Services account.</p>",
"CreateApplicationInput$applicationName": "<p>The name of the application. This name must be unique with the applicable IAM or Amazon Web Services account.</p>",
"CreateDeploymentGroupInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"CreateDeploymentInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"DeleteApplicationInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"DeleteDeploymentGroupInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"DeploymentGroupInfo$applicationName": "<p>The application name.</p>",
"DeploymentInfo$applicationName": "<p>The application name.</p>",
"GetApplicationInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"GetApplicationRevisionInput$applicationName": "<p>The name of the application that corresponds to the revision.</p>",
"GetApplicationRevisionOutput$applicationName": "<p>The name of the application that corresponds to the revision.</p>",
"GetDeploymentGroupInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"ListApplicationRevisionsInput$applicationName": "<p> The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account. </p>",
"ListDeploymentGroupsInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"ListDeploymentGroupsOutput$applicationName": "<p>The application name.</p>",
"ListDeploymentsInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p> <note> <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified. </p> </note>",
"RegisterApplicationRevisionInput$applicationName": "<p>The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.</p>",
"UpdateApplicationInput$applicationName": "<p>The current name of the application you want to change.</p>",
"UpdateApplicationInput$newApplicationName": "<p>The new name to give the application.</p>",
"UpdateDeploymentGroupInput$applicationName": "<p>The application name that corresponds to the deployment group to update.</p>"
}
},
"ApplicationNameRequiredException": {
"base": "<p>The minimum number of required application names was not specified.</p>",
"refs": {
}
},
"ApplicationRevisionSortBy": {
"base": null,
"refs": {
"ListApplicationRevisionsInput$sortBy": "<p>The column name to use to sort the list results:</p> <ul> <li> <p> <code>registerTime</code>: Sort by the time the revisions were registered with CodeDeploy.</p> </li> <li> <p> <code>firstUsedTime</code>: Sort by the time the revisions were first used in a deployment.</p> </li> <li> <p> <code>lastUsedTime</code>: Sort by the time the revisions were last used in a deployment.</p> </li> </ul> <p> If not specified or set to null, the results are returned in an arbitrary order. </p>"
}
},
"ApplicationsInfoList": {
"base": null,
"refs": {
"BatchGetApplicationsOutput$applicationsInfo": "<p>Information about the applications.</p>"
}
},
"ApplicationsList": {
"base": null,
"refs": {
"BatchGetApplicationsInput$applicationNames": "<p>A list of application names separated by spaces. The maximum number of application names you can specify is 100.</p>",
"ListApplicationsOutput$applications": "<p>A list of application names.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"ListTagsForResourceInput$ResourceArn": "<p> The ARN of a CodeDeploy resource. <code>ListTagsForResource</code> returns all the tags associated with the resource that is identified by the <code>ResourceArn</code>. </p>",
"TagResourceInput$ResourceArn": "<p> The ARN of a resource, such as a CodeDeploy application or deployment group. </p>",
"UntagResourceInput$ResourceArn": "<p> The Amazon Resource Name (ARN) that specifies from which resource to disassociate the tags with the keys in the <code>TagKeys</code> input parameter. </p>"
}
},
"ArnNotSupportedException": {
"base": "<p> The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected. </p>",
"refs": {
}
},
"AutoRollbackConfiguration": {
"base": "<p>Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.</p>",
"refs": {
"CreateDeploymentGroupInput$autoRollbackConfiguration": "<p>Configuration information for an automatic rollback that is added when a deployment group is created.</p>",
"CreateDeploymentInput$autoRollbackConfiguration": "<p>Configuration information for an automatic rollback that is added when a deployment is created.</p>",
"DeploymentGroupInfo$autoRollbackConfiguration": "<p>Information about the automatic rollback configuration associated with the deployment group.</p>",
"DeploymentInfo$autoRollbackConfiguration": "<p>Information about the automatic rollback configuration associated with the deployment.</p>",
"UpdateDeploymentGroupInput$autoRollbackConfiguration": "<p>Information for an automatic rollback configuration that is added or changed when a deployment group is updated.</p>"
}
},
"AutoRollbackEvent": {
"base": null,
"refs": {
"AutoRollbackEventsList$member": null
}
},
"AutoRollbackEventsList": {
"base": null,
"refs": {
"AutoRollbackConfiguration$events": "<p>The event type or types that trigger a rollback.</p>"
}
},
"AutoScalingGroup": {
"base": "<p>Information about an Auto Scaling group.</p>",
"refs": {
"AutoScalingGroupList$member": null
}
},
"AutoScalingGroupHook": {
"base": null,
"refs": {
"AutoScalingGroup$hook": "<p>An Auto Scaling lifecycle event hook name.</p>"
}
},
"AutoScalingGroupList": {
"base": null,
"refs": {
"DeleteDeploymentGroupOutput$hooksNotCleanedUp": "<p>If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.</p>",
"DeploymentGroupInfo$autoScalingGroups": "<p>A list of associated Auto Scaling groups.</p>",
"UpdateDeploymentGroupOutput$hooksNotCleanedUp": "<p>If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all 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>"
}
},
"AutoScalingGroupName": {
"base": null,
"refs": {
"AutoScalingGroup$name": "<p>The Auto Scaling group name.</p>",
"AutoScalingGroupNameList$member": null
}
},
"AutoScalingGroupNameList": {
"base": null,
"refs": {
"CreateDeploymentGroupInput$autoScalingGroups": "<p>A list of associated Amazon EC2 Auto Scaling groups.</p>",
"TargetInstances$autoScalingGroups": "<p>The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.</p>",
"UpdateDeploymentGroupInput$autoScalingGroups": "<p>The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.</p> <ul> <li> <p>To keep the Auto Scaling groups, enter their names or do not specify this parameter. </p> </li> <li> <p>To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat\">Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error \"Heartbeat Timeout\"</a> in the <i>CodeDeploy User Guide</i>.</p> </li> </ul>"
}
},
"BatchGetApplicationRevisionsInput": {
"base": "<p>Represents the input of a <code>BatchGetApplicationRevisions</code> operation.</p>",
"refs": {
}
},
"BatchGetApplicationRevisionsOutput": {
"base": "<p>Represents the output of a <code>BatchGetApplicationRevisions</code> operation.</p>",
"refs": {
}
},
"BatchGetApplicationsInput": {
"base": "<p>Represents the input of a <code>BatchGetApplications</code> operation.</p>",
"refs": {
}
},
"BatchGetApplicationsOutput": {
"base": "<p>Represents the output of a <code>BatchGetApplications</code> operation.</p>",
"refs": {
}
},
"BatchGetDeploymentGroupsInput": {
"base": "<p>Represents the input of a <code>BatchGetDeploymentGroups</code> operation.</p>",
"refs": {
}
},
"BatchGetDeploymentGroupsOutput": {
"base": "<p>Represents the output of a <code>BatchGetDeploymentGroups</code> operation.</p>",
"refs": {
}
},
"BatchGetDeploymentInstancesInput": {
"base": "<p> Represents the input of a <code>BatchGetDeploymentInstances</code> operation. </p>",
"refs": {
}
},
"BatchGetDeploymentInstancesOutput": {
"base": "<p>Represents the output of a <code>BatchGetDeploymentInstances</code> operation.</p>",
"refs": {
}
},
"BatchGetDeploymentTargetsInput": {
"base": null,
"refs": {
}
},
"BatchGetDeploymentTargetsOutput": {
"base": null,
"refs": {
}
},
"BatchGetDeploymentsInput": {
"base": "<p> Represents the input of a <code>BatchGetDeployments</code> operation. </p>",
"refs": {
}
},
"BatchGetDeploymentsOutput": {
"base": "<p> Represents the output of a <code>BatchGetDeployments</code> operation. </p>",
"refs": {
}
},
"BatchGetOnPremisesInstancesInput": {
"base": "<p>Represents the input of a <code>BatchGetOnPremisesInstances</code> operation.</p>",
"refs": {
}
},
"BatchGetOnPremisesInstancesOutput": {
"base": "<p>Represents the output of a <code>BatchGetOnPremisesInstances</code> operation.</p>",
"refs": {
}
},
"BatchLimitExceededException": {
"base": "<p>The maximum number of names or IDs allowed for this request (100) was exceeded.</p>",
"refs": {
}
},
"BlueGreenDeploymentConfiguration": {
"base": "<p>Information about blue/green deployment options for a deployment group.</p>",
"refs": {
"CreateDeploymentGroupInput$blueGreenDeploymentConfiguration": "<p>Information about blue/green deployment options for a deployment group.</p>",
"DeploymentGroupInfo$blueGreenDeploymentConfiguration": "<p>Information about blue/green deployment options for a deployment group.</p>",
"DeploymentInfo$blueGreenDeploymentConfiguration": "<p>Information about blue/green deployment options for this deployment.</p>",
"UpdateDeploymentGroupInput$blueGreenDeploymentConfiguration": "<p>Information about blue/green deployment options for a deployment group.</p>"
}
},
"BlueInstanceTerminationOption": {
"base": "<p>Information about whether instances in the original environment are terminated when a blue/green deployment is successful. <code>BlueInstanceTerminationOption</code> does not apply to Lambda deployments. </p>",
"refs": {
"BlueGreenDeploymentConfiguration$terminateBlueInstancesOnDeploymentSuccess": "<p>Information about whether to terminate instances in the original fleet during a blue/green deployment.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"AlarmConfiguration$enabled": "<p>Indicates whether the alarm configuration is enabled.</p>",
"AlarmConfiguration$ignorePollAlarmFailure": "<p>Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.</p> <ul> <li> <p> <code>true</code>: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.</p> </li> <li> <p> <code>false</code>: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.</p> </li> </ul>",
"ApplicationInfo$linkedToGitHub": "<p>True if the user has authenticated with GitHub for the specified application. Otherwise, false.</p>",
"AutoRollbackConfiguration$enabled": "<p>Indicates whether a defined automatic rollback configuration is currently enabled.</p>",
"CreateDeploymentInput$ignoreApplicationStopFailures": "<p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if <code>ApplicationStop</code> fails, the deployment continues with <code>DownloadBundle</code>. If <code>BeforeBlockTraffic</code> fails, the deployment continues with <code>BlockTraffic</code>. If <code>AfterBlockTraffic</code> fails, the deployment continues with <code>ApplicationStop</code>. </p> <p> If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. </p> <p> During a deployment, the CodeDeploy agent runs the scripts specified for <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. </p> <p> If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use <code>ignoreApplicationStopFailures</code> to specify that the <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> failures should be ignored. </p>",
"CreateDeploymentInput$updateOutdatedInstancesOnly": "<p> Indicates whether to deploy to all instances or only to instances that are not running the latest application revision. </p>",
"DeploymentInfo$ignoreApplicationStopFailures": "<p> If true, then if an <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, or <code>AfterBlockTraffic</code> deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if <code>ApplicationStop</code> fails, the deployment continues with DownloadBundle. If <code>BeforeBlockTraffic</code> fails, the deployment continues with <code>BlockTraffic</code>. If <code>AfterBlockTraffic</code> fails, the deployment continues with <code>ApplicationStop</code>. </p> <p> If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. </p> <p> During a deployment, the CodeDeploy agent runs the scripts specified for <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. </p> <p> If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use <code>ignoreApplicationStopFailures</code> to specify that the <code>ApplicationStop</code>, <code>BeforeBlockTraffic</code>, and <code>AfterBlockTraffic</code> failures should be ignored. </p>",
"DeploymentInfo$updateOutdatedInstancesOnly": "<p>Indicates whether only instances that are not running the latest application revision are to be deployed to.</p>",
"DeploymentInfo$instanceTerminationWaitTimeStarted": "<p>Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.</p>"
}
},
"BucketNameFilterRequiredException": {
"base": "<p>A bucket name is required, but was not provided.</p>",
"refs": {
}
},
"BundleType": {
"base": null,
"refs": {
"S3Location$bundleType": "<p>The file type of the application revision. Must be one of the following:</p> <ul> <li> <p> <code>tar</code>: A tar archive file.</p> </li> <li> <p> <code>tgz</code>: A compressed tar archive file.</p> </li> <li> <p> <code>zip</code>: A zip archive file.</p> </li> </ul>"
}
},
"CloudFormationResourceType": {
"base": null,
"refs": {
"CloudFormationTarget$resourceType": "<p>The resource type for the CloudFormation blue/green deployment.</p>"
}
},
"CloudFormationTarget": {
"base": "<p> Information about the target to be updated by an CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.</p>",
"refs": {
"DeploymentTarget$cloudFormationTarget": null
}
},
"CommitId": {
"base": null,
"refs": {
"GitHubLocation$commitId": "<p>The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.</p>"
}
},
"ComputePlatform": {
"base": null,
"refs": {
"ApplicationInfo$computePlatform": "<p>The destination platform type for deployment of the application (<code>Lambda</code> or <code>Server</code>).</p>",
"CreateApplicationInput$computePlatform": "<p> The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</p>",
"CreateDeploymentConfigInput$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</p>",
"DeploymentConfigInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</p>",
"DeploymentGroupInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</p>",
"DeploymentInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</p>"
}
},
"ContinueDeploymentInput": {
"base": null,
"refs": {
}
},
"CreateApplicationInput": {
"base": "<p>Represents the input of a <code>CreateApplication</code> operation.</p>",
"refs": {
}
},
"CreateApplicationOutput": {
"base": "<p>Represents the output of a <code>CreateApplication</code> operation.</p>",
"refs": {
}
},
"CreateDeploymentConfigInput": {
"base": "<p>Represents the input of a <code>CreateDeploymentConfig</code> operation.</p>",
"refs": {
}
},
"CreateDeploymentConfigOutput": {
"base": "<p>Represents the output of a <code>CreateDeploymentConfig</code> operation.</p>",
"refs": {
}
},
"CreateDeploymentGroupInput": {
"base": "<p>Represents the input of a <code>CreateDeploymentGroup</code> operation.</p>",
"refs": {
}
},
"CreateDeploymentGroupOutput": {
"base": "<p>Represents the output of a <code>CreateDeploymentGroup</code> operation.</p>",
"refs": {
}
},
"CreateDeploymentInput": {
"base": "<p>Represents the input of a <code>CreateDeployment</code> operation.</p>",
"refs": {
}
},
"CreateDeploymentOutput": {
"base": "<p> Represents the output of a <code>CreateDeployment</code> operation. </p>",
"refs": {
}
},
"DeleteApplicationInput": {
"base": "<p>Represents the input of a <code>DeleteApplication</code> operation.</p>",
"refs": {
}
},
"DeleteDeploymentConfigInput": {
"base": "<p>Represents the input of a <code>DeleteDeploymentConfig</code> operation.</p>",
"refs": {
}
},
"DeleteDeploymentGroupInput": {
"base": "<p>Represents the input of a <code>DeleteDeploymentGroup</code> operation.</p>",
"refs": {
}
},
"DeleteDeploymentGroupOutput": {
"base": "<p>Represents the output of a <code>DeleteDeploymentGroup</code> operation.</p>",
"refs": {
}
},
"DeleteGitHubAccountTokenInput": {
"base": "<p>Represents the input of a <code>DeleteGitHubAccount</code> operation.</p>",
"refs": {
}
},
"DeleteGitHubAccountTokenOutput": {
"base": "<p>Represents the output of a <code>DeleteGitHubAccountToken</code> operation.</p>",
"refs": {
}
},
"DeleteResourcesByExternalIdInput": {
"base": null,
"refs": {
}
},
"DeleteResourcesByExternalIdOutput": {
"base": null,
"refs": {
}
},
"DeploymentAlreadyCompletedException": {
"base": "<p>The deployment is already complete.</p>",
"refs": {
}
},
"DeploymentAlreadyStartedException": {
"base": "<p> A deployment to a target was attempted while another deployment was in progress. </p>",
"refs": {
}
},
"DeploymentConfigAlreadyExistsException": {
"base": "<p>A deployment configuration with the specified name with the IAM user or Amazon Web Services account already exists.</p>",
"refs": {
}
},
"DeploymentConfigDoesNotExistException": {
"base": "<p>The deployment configuration does not exist with the IAM user or Amazon Web Services account.</p>",
"refs": {
}
},
"DeploymentConfigId": {
"base": null,
"refs": {
"CreateDeploymentConfigOutput$deploymentConfigId": "<p>A unique deployment configuration ID.</p>",
"DeploymentConfigInfo$deploymentConfigId": "<p>The deployment configuration ID.</p>"
}
},
"DeploymentConfigInUseException": {
"base": "<p>The deployment configuration is still in use.</p>",
"refs": {
}
},
"DeploymentConfigInfo": {
"base": "<p>Information about a deployment configuration.</p>",
"refs": {
"GetDeploymentConfigOutput$deploymentConfigInfo": "<p>Information about the deployment configuration.</p>"
}
},
"DeploymentConfigLimitExceededException": {
"base": "<p>The deployment configurations limit was exceeded.</p>",
"refs": {
}
},
"DeploymentConfigName": {
"base": null,
"refs": {
"CreateDeploymentConfigInput$deploymentConfigName": "<p>The name of the deployment configuration to create.</p>",
"CreateDeploymentGroupInput$deploymentConfigName": "<p>If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.</p> <p> <code>CodeDeployDefault.OneAtATime</code> is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.</p> <p>For more information about the predefined deployment configurations in CodeDeploy, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html\">Working with Deployment Configurations in CodeDeploy</a> in the <i>CodeDeploy User Guide</i>.</p>",
"CreateDeploymentInput$deploymentConfigName": "<p>The name of a deployment configuration associated with the IAM user or Amazon Web Services account.</p> <p>If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, <code>CodeDeployDefault</code>.<code>OneAtATime</code> is used by default.</p>",
"DeleteDeploymentConfigInput$deploymentConfigName": "<p>The name of a deployment configuration associated with the IAM user or Amazon Web Services account.</p>",
"DeploymentConfigInfo$deploymentConfigName": "<p>The deployment configuration name.</p>",
"DeploymentConfigsList$member": null,
"DeploymentGroupInfo$deploymentConfigName": "<p>The deployment configuration name.</p>",
"DeploymentInfo$deploymentConfigName": "<p> The deployment configuration name. </p>",
"GetDeploymentConfigInput$deploymentConfigName": "<p>The name of a deployment configuration associated with the IAM user or Amazon Web Services account.</p>",
"UpdateDeploymentGroupInput$deploymentConfigName": "<p>The replacement deployment configuration name to use, if you want to change it.</p>"
}
},
"DeploymentConfigNameRequiredException": {
"base": "<p>The deployment configuration name was not specified.</p>",
"refs": {
}
},
"DeploymentConfigsList": {
"base": null,
"refs": {
"ListDeploymentConfigsOutput$deploymentConfigsList": "<p>A list of deployment configurations, including built-in configurations such as <code>CodeDeployDefault.OneAtATime</code>.</p>"
}
},
"DeploymentCreator": {
"base": null,
"refs": {
"DeploymentInfo$creator": "<p>The means by which the deployment was created:</p> <ul> <li> <p> <code>user</code>: A user created the deployment.</p> </li> <li> <p> <code>autoscaling</code>: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p> <code>codeDeployRollback</code>: A rollback process created the deployment.</p> </li> <li> <p> <code>CodeDeployAutoUpdate</code>: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.</p> </li> </ul>"
}
},
"DeploymentDoesNotExistException": {
"base": "<p>The deployment with the IAM user or Amazon Web Services account does not exist.</p>",
"refs": {
}
},
"DeploymentGroupAlreadyExistsException": {
"base": "<p>A deployment group with the specified name with the IAM user or Amazon Web Services account already exists.</p>",
"refs": {
}
},
"DeploymentGroupDoesNotExistException": {
"base": "<p>The named deployment group with the IAM user or Amazon Web Services account does not exist.</p>",
"refs": {
}
},
"DeploymentGroupId": {
"base": null,
"refs": {
"CreateDeploymentGroupOutput$deploymentGroupId": "<p>A unique deployment group ID.</p>",
"DeploymentGroupInfo$deploymentGroupId": "<p>The deployment group ID.</p>"
}
},
"DeploymentGroupInfo": {
"base": "<p>Information about a deployment group.</p>",
"refs": {
"DeploymentGroupInfoList$member": null,
"GetDeploymentGroupOutput$deploymentGroupInfo": "<p>Information about the deployment group.</p>"
}
},
"DeploymentGroupInfoList": {
"base": null,
"refs": {
"BatchGetDeploymentGroupsOutput$deploymentGroupsInfo": "<p>Information about the deployment groups.</p>"
}
},
"DeploymentGroupLimitExceededException": {
"base": "<p> The deployment groups limit was exceeded.</p>",
"refs": {
}
},
"DeploymentGroupName": {
"base": null,
"refs": {
"CreateDeploymentGroupInput$deploymentGroupName": "<p>The name of a new deployment group for the specified application.</p>",
"CreateDeploymentInput$deploymentGroupName": "<p>The name of the deployment group.</p>",
"DeleteDeploymentGroupInput$deploymentGroupName": "<p>The name of a deployment group for the specified application.</p>",
"DeploymentGroupInfo$deploymentGroupName": "<p>The deployment group name.</p>",
"DeploymentGroupsList$member": null,
"DeploymentInfo$deploymentGroupName": "<p> The deployment group name. </p>",
"GetDeploymentGroupInput$deploymentGroupName": "<p>The name of a deployment group for the specified application.</p>",
"ListDeploymentsInput$deploymentGroupName": "<p>The name of a deployment group for the specified application.</p> <note> <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified. </p> </note>",
"UpdateDeploymentGroupInput$currentDeploymentGroupName": "<p>The current name of the deployment group.</p>",
"UpdateDeploymentGroupInput$newDeploymentGroupName": "<p>The new name of the deployment group, if you want to change it.</p>"
}
},
"DeploymentGroupNameRequiredException": {
"base": "<p>The deployment group name was not specified.</p>",
"refs": {
}
},
"DeploymentGroupsList": {
"base": null,
"refs": {
"BatchGetDeploymentGroupsInput$deploymentGroupNames": "<p>The names of the deployment groups.</p>",
"GenericRevisionInfo$deploymentGroups": "<p>The deployment groups for which this is the current target revision.</p>",
"ListDeploymentGroupsOutput$deploymentGroups": "<p>A list of deployment group names.</p>"
}
},
"DeploymentId": {
"base": null,
"refs": {
"BatchGetDeploymentInstancesInput$deploymentId": "<p> The unique ID of a deployment. </p>",
"BatchGetDeploymentTargetsInput$deploymentId": "<p> The unique ID of a deployment. </p>",
"CloudFormationTarget$deploymentId": "<p>The unique ID of an CloudFormation blue/green deployment.</p>",
"ContinueDeploymentInput$deploymentId": "<p> The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment. </p>",
"CreateDeploymentOutput$deploymentId": "<p> The unique ID of a deployment. </p>",
"DeploymentInfo$deploymentId": "<p> The unique ID of a deployment. </p>",
"DeploymentsList$member": null,
"ECSTarget$deploymentId": "<p> The unique ID of a deployment. </p>",
"GetDeploymentInput$deploymentId": "<p> The unique ID of a deployment associated with the IAM user or Amazon Web Services account. </p>",
"GetDeploymentInstanceInput$deploymentId": "<p> The unique ID of a deployment. </p>",
"GetDeploymentTargetInput$deploymentId": "<p> The unique ID of a deployment. </p>",
"InstanceSummary$deploymentId": "<p> The unique ID of a deployment. </p>",
"InstanceTarget$deploymentId": "<p> The unique ID of a deployment. </p>",
"LambdaTarget$deploymentId": "<p> The unique ID of a deployment. </p>",
"LastDeploymentInfo$deploymentId": "<p> The unique ID of a deployment. </p>",
"ListDeploymentInstancesInput$deploymentId": "<p> The unique ID of a deployment. </p>",
"ListDeploymentTargetsInput$deploymentId": "<p> The unique ID of a deployment. </p>",
"PutLifecycleEventHookExecutionStatusInput$deploymentId": "<p> The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event. </p>",
"RelatedDeployments$autoUpdateOutdatedInstancesRootDeploymentId": "<p>The deployment ID of the root deployment that triggered this deployment.</p>",
"RollbackInfo$rollbackDeploymentId": "<p>The ID of the deployment rollback.</p>",
"RollbackInfo$rollbackTriggeringDeploymentId": "<p>The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.</p>",
"SkipWaitTimeForInstanceTerminationInput$deploymentId": "<p> The unique ID of a blue/green deployment for which you want to skip the instance termination wait time. </p>",
"StopDeploymentInput$deploymentId": "<p> The unique ID of a deployment. </p>"
}
},
"DeploymentIdRequiredException": {
"base": "<p>At least one deployment ID must be specified.</p>",
"refs": {
}
},
"DeploymentInfo": {
"base": "<p>Information about a deployment.</p>",
"refs": {
"DeploymentsInfoList$member": null,
"GetDeploymentOutput$deploymentInfo": "<p>Information about the deployment.</p>"
}
},
"DeploymentIsNotInReadyStateException": {
"base": "<p>The deployment does not have a status of Ready and can't continue yet.</p>",
"refs": {
}
},
"DeploymentLimitExceededException": {
"base": "<p>The number of allowed deployments was exceeded.</p>",
"refs": {
}
},
"DeploymentNotStartedException": {
"base": "<p>The specified deployment has not started.</p>",
"refs": {
}
},
"DeploymentOption": {
"base": null,
"refs": {
"DeploymentStyle$deploymentOption": "<p>Indicates whether to route deployment traffic behind a load balancer.</p>"
}
},
"DeploymentOverview": {
"base": "<p>Information about the deployment status of the instances in the deployment.</p>",
"refs": {
"DeploymentInfo$deploymentOverview": "<p>A summary of the deployment status of the instances in the deployment.</p>"
}
},
"DeploymentReadyAction": {
"base": null,
"refs": {
"DeploymentReadyOption$actionOnTimeout": "<p>Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.</p> <ul> <li> <p>CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.</p> </li> <li> <p>STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using <a>ContinueDeployment</a>. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.</p> </li> </ul>"
}
},
"DeploymentReadyOption": {
"base": "<p>Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.</p>",
"refs": {
"BlueGreenDeploymentConfiguration$deploymentReadyOption": "<p>Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.</p>"
}
},
"DeploymentStatus": {
"base": null,
"refs": {
"DeploymentInfo$status": "<p>The current state of the deployment as a whole.</p>",
"DeploymentStatusList$member": null,
"LastDeploymentInfo$status": "<p>The status of the most recent deployment.</p>"
}
},
"DeploymentStatusList": {
"base": null,
"refs": {
"ListDeploymentsInput$includeOnlyStatuses": "<p>A subset of deployments to list by status:</p> <ul> <li> <p> <code>Created</code>: Include created deployments in the resulting list.</p> </li> <li> <p> <code>Queued</code>: Include queued deployments in the resulting list.</p> </li> <li> <p> <code>In Progress</code>: Include in-progress deployments in the resulting list.</p> </li> <li> <p> <code>Succeeded</code>: Include successful deployments in the resulting list.</p> </li> <li> <p> <code>Failed</code>: Include failed deployments in the resulting list.</p> </li> <li> <p> <code>Stopped</code>: Include stopped deployments in the resulting list.</p> </li> </ul>"
}
},
"DeploymentStatusMessageList": {
"base": null,
"refs": {
"DeploymentInfo$deploymentStatusMessages": "<p>Messages that contain information about the status of a deployment.</p>"
}
},
"DeploymentStyle": {
"base": "<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>",
"refs": {
"CreateDeploymentGroupInput$deploymentStyle": "<p>Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.</p>",
"DeploymentGroupInfo$deploymentStyle": "<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>",
"DeploymentInfo$deploymentStyle": "<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>",
"UpdateDeploymentGroupInput$deploymentStyle": "<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
}
},
"DeploymentTarget": {
"base": "<p> Information about the deployment target. </p>",
"refs": {
"DeploymentTargetList$member": null,
"GetDeploymentTargetOutput$deploymentTarget": "<p> A deployment target that contains information about a deployment such as its status, lifecycle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (<code>instanceTarget</code>, <code>lambdaTarget</code>, or <code>ecsTarget</code>). </p>"
}
},
"DeploymentTargetDoesNotExistException": {
"base": "<p> The provided target ID does not belong to the attempted deployment. </p>",
"refs": {
}
},
"DeploymentTargetIdRequiredException": {
"base": "<p> A deployment target ID was not provided. </p>",
"refs": {
}
},
"DeploymentTargetList": {
"base": null,
"refs": {
"BatchGetDeploymentTargetsOutput$deploymentTargets": "<p> A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform. </p> <ul> <li> <p> <b>EC2/On-premises</b>: Each target object is an Amazon EC2 or on-premises instance. </p> </li> <li> <p> <b>Lambda</b>: The target object is a specific version of an Lambda function. </p> </li> <li> <p> <b>Amazon ECS</b>: The target object is an Amazon ECS service. </p> </li> <li> <p> <b>CloudFormation</b>: The target object is an CloudFormation blue/green deployment. </p> </li> </ul>"
}
},
"DeploymentTargetListSizeExceededException": {
"base": "<p> The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments. </p>",
"refs": {
}
},
"DeploymentTargetType": {
"base": null,
"refs": {
"DeploymentTarget$deploymentTargetType": "<p>The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.</p>"
}
},
"DeploymentType": {
"base": null,
"refs": {
"DeploymentStyle$deploymentType": "<p>Indicates whether to run an in-place deployment or a blue/green deployment.</p>"
}
},
"DeploymentWaitType": {
"base": null,
"refs": {
"ContinueDeploymentInput$deploymentWaitType": "<p> The status of the deployment's waiting period. <code>READY_WAIT</code> indicates that the deployment is ready to start shifting traffic. <code>TERMINATION_WAIT</code> indicates that the traffic is shifted, but the original target is not terminated. </p>"
}
},
"DeploymentsInfoList": {
"base": null,
"refs": {
"BatchGetDeploymentsOutput$deploymentsInfo": "<p> Information about the deployments. </p>"
}
},
"DeploymentsList": {
"base": null,
"refs": {
"BatchGetDeploymentsInput$deploymentIds": "<p> A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.</p>",
"ListDeploymentsOutput$deployments": "<p>A list of deployment IDs.</p>",
"RelatedDeployments$autoUpdateOutdatedInstancesDeploymentIds": "<p>The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.</p>"
}
},
"DeregisterOnPremisesInstanceInput": {
"base": "<p>Represents the input of a <code>DeregisterOnPremisesInstance</code> operation.</p>",
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"CreateDeploymentInput$description": "<p>A comment about the deployment.</p>",
"DeploymentInfo$description": "<p>A comment about the deployment.</p>",
"GenericRevisionInfo$description": "<p>A comment about the revision.</p>",
"RegisterApplicationRevisionInput$description": "<p>A comment about the revision.</p>",
"RollbackInfo$rollbackMessage": "<p>Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded). </p>"
}
},
"DescriptionTooLongException": {
"base": "<p>The description is too long.</p>",
"refs": {
}
},
"Diagnostics": {
"base": "<p>Diagnostic information about executable scripts that are part of a deployment.</p>",
"refs": {
"LifecycleEvent$diagnostics": "<p>Diagnostic information about the deployment lifecycle event.</p>"
}
},
"Duration": {
"base": null,
"refs": {
"BlueInstanceTerminationOption$terminationWaitTimeInMinutes": "<p>For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.</p> <p> For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. </p> <p> The maximum setting is 2880 minutes (2 days). </p>",
"DeploymentReadyOption$waitTimeInMinutes": "<p>The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the <code>STOP_DEPLOYMENT</code> option for <code>actionOnTimeout</code>.</p>"
}
},
"EC2TagFilter": {
"base": "<p>Information about an EC2 tag filter.</p>",
"refs": {
"EC2TagFilterList$member": null
}
},
"EC2TagFilterList": {
"base": null,
"refs": {
"CreateDeploymentGroupInput$ec2TagFilters": "<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 as ec2TagSet.</p>",
"DeploymentGroupInfo$ec2TagFilters": "<p>The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.</p>",
"EC2TagSetList$member": null,
"TargetInstances$tagFilters": "<p>The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as <code>ec2TagSet</code>.</p>",
"UpdateDeploymentGroupInput$ec2TagFilters": "<p>The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.</p>"
}
},
"EC2TagFilterType": {
"base": null,
"refs": {
"EC2TagFilter$Type": "<p>The tag filter type:</p> <ul> <li> <p> <code>KEY_ONLY</code>: Key only.</p> </li> <li> <p> <code>VALUE_ONLY</code>: Value only.</p> </li> <li> <p> <code>KEY_AND_VALUE</code>: Key and value.</p> </li> </ul>"
}
},
"EC2TagSet": {
"base": "<p>Information about groups of Amazon EC2 instance tags.</p>",
"refs": {
"CreateDeploymentGroupInput$ec2TagSet": "<p>Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as <code>ec2TagFilters</code>.</p>",
"DeploymentGroupInfo$ec2TagSet": "<p>Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.</p>",
"TargetInstances$ec2TagSet": "<p>Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as <code>tagFilters</code>.</p>",
"UpdateDeploymentGroupInput$ec2TagSet": "<p>Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.</p>"
}
},
"EC2TagSetList": {
"base": null,
"refs": {
"EC2TagSet$ec2TagSetList": "<p>A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.</p>"
}
},
"ECSClusterName": {
"base": null,
"refs": {
"ECSService$clusterName": "<p> The name of the cluster that the Amazon ECS service is associated with. </p>"
}
},
"ECSService": {
"base": "<p> Contains the service and cluster names used to identify an Amazon ECS deployment's target. </p>",
"refs": {
"ECSServiceList$member": null
}
},
"ECSServiceList": {
"base": null,
"refs": {
"CreateDeploymentGroupInput$ecsServices": "<p> The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code><clustername>:<servicename></code>. </p>",
"DeploymentGroupInfo$ecsServices": "<p> The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code><clustername>:<servicename></code>. </p>",
"UpdateDeploymentGroupInput$ecsServices": "<p> The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code><clustername>:<servicename></code>. </p>"
}
},
"ECSServiceMappingLimitExceededException": {
"base": "<p> The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group. </p>",
"refs": {
}
},
"ECSServiceName": {
"base": null,
"refs": {
"ECSService$serviceName": "<p> The name of the target Amazon ECS service. </p>"
}
},
"ECSTarget": {
"base": "<p> Information about the target of an Amazon ECS deployment. </p>",
"refs": {
"DeploymentTarget$ecsTarget": "<p> Information about the target for a deployment that uses the Amazon ECS compute platform. </p>"
}
},
"ECSTaskSet": {
"base": "<p> Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set. </p>",
"refs": {
"ECSTaskSetList$member": null
}
},
"ECSTaskSetCount": {
"base": null,
"refs": {
"ECSTaskSet$desiredCount": "<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 uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. </p>",
"ECSTaskSet$pendingCount": "<p> The number of tasks in the task set that are in the <code>PENDING</code> status during an Amazon ECS deployment. A task in the <code>PENDING</code> state is preparing to enter the <code>RUNNING</code> state. A task set enters the <code>PENDING</code> status when it launches for the first time, or when it is restarted after being in the <code>STOPPED</code> state. </p>",
"ECSTaskSet$runningCount": "<p> The number of tasks in the task set that are in the <code>RUNNING</code> status during an Amazon ECS deployment. A task in the <code>RUNNING</code> state is running and ready for use. </p>"
}
},
"ECSTaskSetIdentifier": {
"base": null,
"refs": {
"ECSTaskSet$identifer": "<p> A unique ID of an <code>ECSTaskSet</code>. </p>"
}
},
"ECSTaskSetList": {
"base": null,
"refs": {
"ECSTarget$taskSetsInfo": "<p> The <code>ECSTaskSet</code> objects associated with the ECS target. </p>"
}
},
"ECSTaskSetStatus": {
"base": null,
"refs": {
"ECSTaskSet$status": "<p> The status of the task set. There are three valid task set statuses: </p> <ul> <li> <p> <code>PRIMARY</code>: Indicates the task set is serving production traffic. </p> </li> <li> <p> <code>ACTIVE</code>: Indicates the task set is not serving production traffic. </p> </li> <li> <p> <code>DRAINING</code>: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. </p> </li> </ul>"
}
},
"ELBInfo": {
"base": "<p>Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.</p>",
"refs": {
"ELBInfoList$member": null
}
},
"ELBInfoList": {
"base": null,
"refs": {
"LoadBalancerInfo$elbInfoList": "<p>An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p> <note> <p> Adding more than one load balancer to the array is not supported. </p> </note>"
}
},
"ELBName": {
"base": null,
"refs": {
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.</p>"
}
},
"ETag": {
"base": null,
"refs": {
"S3Location$eTag": "<p>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the ETag is not specified as an input parameter, ETag validation of the object is skipped.</p>"
}
},
"ErrorCode": {
"base": null,
"refs": {
"ErrorInformation$code": "<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> <p>The error code:</p> <ul> <li> <p>APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>IAM_ROLE_MISSING: The service role cannot be accessed.</p> </li> <li> <p>IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.</p> </li> <li> <p>INTERNAL_ERROR: There was an internal error.</p> </li> <li> <p>NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.</p> </li> <li> <p>NO_INSTANCES: No instances were specified, or no instances can be found.</p> </li> <li> <p>OVER_MAX_INSTANCES: The maximum number of instances was exceeded.</p> </li> <li> <p>THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more Amazon Web Services services.</p> </li> <li> <p>TIMEOUT: The deployment has timed out.</p> </li> <li> <p>REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.</p> </li> </ul>"
}
},
"ErrorInformation": {
"base": "<p>Information about a deployment error.</p>",
"refs": {
"DeploymentInfo$errorInformation": "<p>Information about any error associated with this deployment.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"BatchGetApplicationRevisionsOutput$errorMessage": "<p>Information about errors that might have occurred during the API call.</p>",
"BatchGetDeploymentGroupsOutput$errorMessage": "<p>Information about errors that might have occurred during the API call.</p>",
"BatchGetDeploymentInstancesOutput$errorMessage": "<p>Information about errors that might have occurred during the API call.</p>",
"DeploymentStatusMessageList$member": null,
"ErrorInformation$message": "<p>An accompanying error message.</p>"
}
},
"ExternalId": {
"base": null,
"refs": {
"DeleteResourcesByExternalIdInput$externalId": "<p>The unique ID of an external resource (for example, a CloudFormation stack ID) that is linked to one or more CodeDeploy resources.</p>",
"DeploymentInfo$externalId": "<p>The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.</p>",
"ListDeploymentsInput$externalId": "<p>The unique ID of an external resource for returning deployments linked to the external resource.</p>"
}
},
"FileExistsBehavior": {
"base": null,
"refs": {
"CreateDeploymentInput$fileExistsBehavior": "<p>Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.</p> <p>The <code>fileExistsBehavior</code> parameter takes any of the following values:</p> <ul> <li> <p>DISALLOW: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p>OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p>RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>",
"DeploymentInfo$fileExistsBehavior": "<p>Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.</p> <ul> <li> <p> <code>DISALLOW</code>: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p> <code>OVERWRITE</code>: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p> <code>RETAIN</code>: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>"
}
},
"FilterValue": {
"base": null,
"refs": {
"FilterValueList$member": null
}