forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathelasticloadbalancingv2-2015-12-01.normal.json
2472 lines (2472 loc) · 89 KB
/
elasticloadbalancingv2-2015-12-01.normal.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",
"metadata":{
"apiVersion":"2015-12-01",
"endpointPrefix":"elasticloadbalancing",
"protocol":"query",
"serviceAbbreviation":"Elastic Load Balancing v2",
"serviceFullName":"Elastic Load Balancing",
"signatureVersion":"v4",
"uid":"elasticloadbalancingv2-2015-12-01",
"xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/"
},
"operations":{
"AddTags":{
"name":"AddTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsInput"},
"output":{
"shape":"AddTagsOutput",
"resultWrapper":"AddTagsResult"
},
"errors":[
{"shape":"DuplicateTagKeysException"},
{"shape":"TooManyTagsException"},
{"shape":"LoadBalancerNotFoundException"},
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Adds the specified tags to the specified resource. You can tag your Application Load Balancers and your target groups.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, <code>AddTags</code> updates its value.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>. To remove tags from your resources, use <a>RemoveTags</a>.</p>"
},
"CreateListener":{
"name":"CreateListener",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateListenerInput"},
"output":{
"shape":"CreateListenerOutput",
"resultWrapper":"CreateListenerResult"
},
"errors":[
{"shape":"DuplicateListenerException"},
{"shape":"TooManyListenersException"},
{"shape":"TooManyCertificatesException"},
{"shape":"LoadBalancerNotFoundException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"TargetGroupAssociationLimitException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"IncompatibleProtocolsException"},
{"shape":"SSLPolicyNotFoundException"},
{"shape":"CertificateNotFoundException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Creates a listener for the specified Application Load Balancer.</p> <p>You can create up to 10 listeners per load balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"CreateLoadBalancer":{
"name":"CreateLoadBalancer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateLoadBalancerInput"},
"output":{
"shape":"CreateLoadBalancerOutput",
"resultWrapper":"CreateLoadBalancerResult"
},
"errors":[
{"shape":"DuplicateLoadBalancerNameException"},
{"shape":"TooManyLoadBalancersException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"SubnetNotFoundException"},
{"shape":"InvalidSubnetException"},
{"shape":"InvalidSecurityGroupException"},
{"shape":"InvalidSchemeException"},
{"shape":"TooManyTagsException"},
{"shape":"DuplicateTagKeysException"}
],
"documentation":"<p>Creates an Application Load Balancer.</p> <p>When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, <a>SetIpAddressType</a>, and <a>AddTags</a>.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"CreateRule":{
"name":"CreateRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateRuleInput"},
"output":{
"shape":"CreateRuleOutput",
"resultWrapper":"CreateRuleResult"
},
"errors":[
{"shape":"PriorityInUseException"},
{"shape":"TooManyTargetGroupsException"},
{"shape":"TooManyRulesException"},
{"shape":"TargetGroupAssociationLimitException"},
{"shape":"ListenerNotFoundException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Creates a rule for the specified listener.</p> <p>Each rule can have one action and one condition. Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the default action for the default rule is taken. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener Rules</a> in the <i>Application Load Balancers Guide</i>.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>"
},
"CreateTargetGroup":{
"name":"CreateTargetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTargetGroupInput"},
"output":{
"shape":"CreateTargetGroupOutput",
"resultWrapper":"CreateTargetGroupResult"
},
"errors":[
{"shape":"DuplicateTargetGroupNameException"},
{"shape":"TooManyTargetGroupsException"}
],
"documentation":"<p>Creates a target group.</p> <p>To register targets with the target group, use <a>RegisterTargets</a>. To update the health check settings for the target group, use <a>ModifyTargetGroup</a>. To monitor the health of targets in the target group, use <a>DescribeTargetHealth</a>.</p> <p>To route traffic to the targets in a target group, specify the target group in an action using <a>CreateListener</a> or <a>CreateRule</a>.</p> <p>To delete a target group, use <a>DeleteTargetGroup</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html\">Target Groups for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"DeleteListener":{
"name":"DeleteListener",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteListenerInput"},
"output":{
"shape":"DeleteListenerOutput",
"resultWrapper":"DeleteListenerResult"
},
"errors":[
{"shape":"ListenerNotFoundException"}
],
"documentation":"<p>Deletes the specified listener.</p> <p>Alternatively, your listener is deleted when you delete the load balancer it is attached to using <a>DeleteLoadBalancer</a>.</p>"
},
"DeleteLoadBalancer":{
"name":"DeleteLoadBalancer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteLoadBalancerInput"},
"output":{
"shape":"DeleteLoadBalancerOutput",
"resultWrapper":"DeleteLoadBalancerResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Deletes the specified Application Load Balancer and its attached listeners.</p> <p>You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.</p> <p>Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.</p>"
},
"DeleteRule":{
"name":"DeleteRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRuleInput"},
"output":{
"shape":"DeleteRuleOutput",
"resultWrapper":"DeleteRuleResult"
},
"errors":[
{"shape":"RuleNotFoundException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Deletes the specified rule.</p>"
},
"DeleteTargetGroup":{
"name":"DeleteTargetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTargetGroupInput"},
"output":{
"shape":"DeleteTargetGroupOutput",
"resultWrapper":"DeleteTargetGroupResult"
},
"errors":[
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes the specified target group.</p> <p>You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.</p>"
},
"DeregisterTargets":{
"name":"DeregisterTargets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterTargetsInput"},
"output":{
"shape":"DeregisterTargetsOutput",
"resultWrapper":"DeregisterTargetsResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"},
{"shape":"InvalidTargetException"}
],
"documentation":"<p>Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.</p>"
},
"DescribeListeners":{
"name":"DescribeListeners",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeListenersInput"},
"output":{
"shape":"DescribeListenersOutput",
"resultWrapper":"DescribeListenersResult"
},
"errors":[
{"shape":"ListenerNotFoundException"},
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the specified listeners or the listeners for the specified Application Load Balancer. You must specify either a load balancer or one or more listeners.</p>"
},
"DescribeLoadBalancerAttributes":{
"name":"DescribeLoadBalancerAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLoadBalancerAttributesInput"},
"output":{
"shape":"DescribeLoadBalancerAttributesOutput",
"resultWrapper":"DescribeLoadBalancerAttributesResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified Application Load Balancer.</p>"
},
"DescribeLoadBalancers":{
"name":"DescribeLoadBalancers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLoadBalancersInput"},
"output":{
"shape":"DescribeLoadBalancersOutput",
"resultWrapper":"DescribeLoadBalancersResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the specified Application Load Balancers or all of your Application Load Balancers.</p> <p>To describe the listeners for a load balancer, use <a>DescribeListeners</a>. To describe the attributes for a load balancer, use <a>DescribeLoadBalancerAttributes</a>.</p>"
},
"DescribeRules":{
"name":"DescribeRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeRulesInput"},
"output":{
"shape":"DescribeRulesOutput",
"resultWrapper":"DescribeRulesResult"
},
"errors":[
{"shape":"ListenerNotFoundException"},
{"shape":"RuleNotFoundException"}
],
"documentation":"<p>Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.</p>"
},
"DescribeSSLPolicies":{
"name":"DescribeSSLPolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSSLPoliciesInput"},
"output":{
"shape":"DescribeSSLPoliciesOutput",
"resultWrapper":"DescribeSSLPoliciesResult"
},
"errors":[
{"shape":"SSLPolicyNotFoundException"}
],
"documentation":"<p>Describes the specified policies or all policies used for SSL negotiation.</p> <p>Note that the only supported policy at this time is ELBSecurityPolicy-2015-05.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTagsInput"},
"output":{
"shape":"DescribeTagsOutput",
"resultWrapper":"DescribeTagsResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"ListenerNotFoundException"},
{"shape":"RuleNotFoundException"}
],
"documentation":"<p>Describes the tags for the specified resources.</p>"
},
"DescribeTargetGroupAttributes":{
"name":"DescribeTargetGroupAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTargetGroupAttributesInput"},
"output":{
"shape":"DescribeTargetGroupAttributesOutput",
"resultWrapper":"DescribeTargetGroupAttributesResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified target group.</p>"
},
"DescribeTargetGroups":{
"name":"DescribeTargetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTargetGroupsInput"},
"output":{
"shape":"DescribeTargetGroupsOutput",
"resultWrapper":"DescribeTargetGroupsResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.</p> <p>To describe the targets for a target group, use <a>DescribeTargetHealth</a>. To describe the attributes of a target group, use <a>DescribeTargetGroupAttributes</a>.</p>"
},
"DescribeTargetHealth":{
"name":"DescribeTargetHealth",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTargetHealthInput"},
"output":{
"shape":"DescribeTargetHealthOutput",
"resultWrapper":"DescribeTargetHealthResult"
},
"errors":[
{"shape":"InvalidTargetException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"HealthUnavailableException"}
],
"documentation":"<p>Describes the health of the specified targets or all of your targets.</p>"
},
"ModifyListener":{
"name":"ModifyListener",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyListenerInput"},
"output":{
"shape":"ModifyListenerOutput",
"resultWrapper":"ModifyListenerResult"
},
"errors":[
{"shape":"DuplicateListenerException"},
{"shape":"TooManyListenersException"},
{"shape":"TooManyCertificatesException"},
{"shape":"ListenerNotFoundException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"TargetGroupAssociationLimitException"},
{"shape":"IncompatibleProtocolsException"},
{"shape":"SSLPolicyNotFoundException"},
{"shape":"CertificateNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Modifies the specified properties of the specified listener.</p> <p>Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy.</p>"
},
"ModifyLoadBalancerAttributes":{
"name":"ModifyLoadBalancerAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyLoadBalancerAttributesInput"},
"output":{
"shape":"ModifyLoadBalancerAttributesOutput",
"resultWrapper":"ModifyLoadBalancerAttributesResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"InvalidConfigurationRequestException"}
],
"documentation":"<p>Modifies the specified attributes of the specified Application Load Balancer.</p> <p>If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.</p>"
},
"ModifyRule":{
"name":"ModifyRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyRuleInput"},
"output":{
"shape":"ModifyRuleOutput",
"resultWrapper":"ModifyRuleResult"
},
"errors":[
{"shape":"TargetGroupAssociationLimitException"},
{"shape":"RuleNotFoundException"},
{"shape":"OperationNotPermittedException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Modifies the specified rule.</p> <p>Any existing properties that you do not modify retain their current values.</p> <p>To modify the default action, use <a>ModifyListener</a>.</p>"
},
"ModifyTargetGroup":{
"name":"ModifyTargetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyTargetGroupInput"},
"output":{
"shape":"ModifyTargetGroupOutput",
"resultWrapper":"ModifyTargetGroupResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Modifies the health checks used when evaluating the health state of the targets in the specified target group.</p> <p>To monitor the health of the targets, use <a>DescribeTargetHealth</a>.</p>"
},
"ModifyTargetGroupAttributes":{
"name":"ModifyTargetGroupAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyTargetGroupAttributesInput"},
"output":{
"shape":"ModifyTargetGroupAttributesOutput",
"resultWrapper":"ModifyTargetGroupAttributesResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Modifies the specified attributes of the specified target group.</p>"
},
"RegisterTargets":{
"name":"RegisterTargets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterTargetsInput"},
"output":{
"shape":"RegisterTargetsOutput",
"resultWrapper":"RegisterTargetsResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"},
{"shape":"TooManyTargetsException"},
{"shape":"InvalidTargetException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
],
"documentation":"<p>Registers the specified targets with the specified target group.</p> <p>By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.</p> <p>The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is an EC2 instance, it must be in the <code>running</code> state when you register it.</p> <p>To remove a target from a target group, use <a>DeregisterTargets</a>.</p>"
},
"RemoveTags":{
"name":"RemoveTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsInput"},
"output":{
"shape":"RemoveTagsOutput",
"resultWrapper":"RemoveTagsResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"ListenerNotFoundException"},
{"shape":"RuleNotFoundException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Removes the specified tags from the specified resource.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>.</p>"
},
"SetIpAddressType":{
"name":"SetIpAddressType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetIpAddressTypeInput"},
"output":{
"shape":"SetIpAddressTypeOutput",
"resultWrapper":"SetIpAddressTypeResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"InvalidSubnetException"}
],
"documentation":"<p>Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.</p>"
},
"SetRulePriorities":{
"name":"SetRulePriorities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetRulePrioritiesInput"},
"output":{
"shape":"SetRulePrioritiesOutput",
"resultWrapper":"SetRulePrioritiesResult"
},
"errors":[
{"shape":"RuleNotFoundException"},
{"shape":"PriorityInUseException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Sets the priorities of the specified rules.</p> <p>You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.</p>"
},
"SetSecurityGroups":{
"name":"SetSecurityGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetSecurityGroupsInput"},
"output":{
"shape":"SetSecurityGroupsOutput",
"resultWrapper":"SetSecurityGroupsResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"InvalidSecurityGroupException"}
],
"documentation":"<p>Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.</p>"
},
"SetSubnets":{
"name":"SetSubnets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetSubnetsInput"},
"output":{
"shape":"SetSubnetsOutput",
"resultWrapper":"SetSubnetsResult"
},
"errors":[
{"shape":"LoadBalancerNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"SubnetNotFoundException"},
{"shape":"InvalidSubnetException"}
],
"documentation":"<p>Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.</p>"
}
},
"shapes":{
"Action":{
"type":"structure",
"required":[
"Type",
"TargetGroupArn"
],
"members":{
"Type":{
"shape":"ActionTypeEnum",
"documentation":"<p>The type of action.</p>"
},
"TargetGroupArn":{
"shape":"TargetGroupArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the target group.</p>"
}
},
"documentation":"<p>Information about an action.</p>"
},
"ActionTypeEnum":{
"type":"string",
"enum":["forward"]
},
"Actions":{
"type":"list",
"member":{"shape":"Action"}
},
"AddTagsInput":{
"type":"structure",
"required":[
"ResourceArns",
"Tags"
],
"members":{
"ResourceArns":{
"shape":"ResourceArns",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags. Each resource can have a maximum of 10 tags.</p>"
}
}
},
"AddTagsOutput":{
"type":"structure",
"members":{
}
},
"AvailabilityZone":{
"type":"structure",
"members":{
"ZoneName":{
"shape":"ZoneName",
"documentation":"<p>The name of the Availability Zone.</p>"
},
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>The ID of the subnet.</p>"
}
},
"documentation":"<p>Information about an Availability Zone.</p>"
},
"AvailabilityZones":{
"type":"list",
"member":{"shape":"AvailabilityZone"}
},
"CanonicalHostedZoneId":{"type":"string"},
"Certificate":{
"type":"structure",
"members":{
"CertificateArn":{
"shape":"CertificateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the certificate.</p>"
}
},
"documentation":"<p>Information about an SSL server certificate deployed on a load balancer.</p>"
},
"CertificateArn":{"type":"string"},
"CertificateList":{
"type":"list",
"member":{"shape":"Certificate"}
},
"CertificateNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified certificate does not exist.</p>",
"error":{
"code":"CertificateNotFound",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"Cipher":{
"type":"structure",
"members":{
"Name":{
"shape":"CipherName",
"documentation":"<p>The name of the cipher.</p>"
},
"Priority":{
"shape":"CipherPriority",
"documentation":"<p>The priority of the cipher.</p>"
}
},
"documentation":"<p>Information about a cipher used in a policy.</p>"
},
"CipherName":{"type":"string"},
"CipherPriority":{"type":"integer"},
"Ciphers":{
"type":"list",
"member":{"shape":"Cipher"}
},
"ConditionFieldName":{
"type":"string",
"max":64
},
"CreateListenerInput":{
"type":"structure",
"required":[
"LoadBalancerArn",
"Protocol",
"Port",
"DefaultActions"
],
"members":{
"LoadBalancerArn":{
"shape":"LoadBalancerArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the load balancer.</p>"
},
"Protocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol for connections from clients to the load balancer.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>The port on which the load balancer is listening.</p>"
},
"SslPolicy":{
"shape":"SslPolicyName",
"documentation":"<p>The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>"
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>The SSL server certificate. You must provide exactly one certificate if the protocol is HTTPS.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The default action for the listener.</p>"
}
}
},
"CreateListenerOutput":{
"type":"structure",
"members":{
"Listeners":{
"shape":"Listeners",
"documentation":"<p>Information about the listener.</p>"
}
}
},
"CreateLoadBalancerInput":{
"type":"structure",
"required":[
"Name",
"Subnets"
],
"members":{
"Name":{
"shape":"LoadBalancerName",
"documentation":"<p>The name of the load balancer.</p> <p>This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.</p>"
},
"Subnets":{
"shape":"Subnets",
"documentation":"<p>The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones.</p>"
},
"SecurityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>The IDs of the security groups to assign to the load balancer.</p>"
},
"Scheme":{
"shape":"LoadBalancerSchemeEnum",
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.</p> <p>The default is an Internet-facing load balancer.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tags to assign to the load balancer.</p>"
},
"IpAddressType":{
"shape":"IpAddressType",
"documentation":"<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). Internal load balancers must use <code>ipv4</code>.</p>"
}
}
},
"CreateLoadBalancerOutput":{
"type":"structure",
"members":{
"LoadBalancers":{
"shape":"LoadBalancers",
"documentation":"<p>Information about the load balancer.</p>"
}
}
},
"CreateRuleInput":{
"type":"structure",
"required":[
"ListenerArn",
"Conditions",
"Priority",
"Actions"
],
"members":{
"ListenerArn":{
"shape":"ListenerArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the listener.</p>"
},
"Conditions":{
"shape":"RuleConditionList",
"documentation":"<p>A condition. Each condition has the field <code>path-pattern</code> and specifies one path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters in a path pattern.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>& (using &amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
},
"Priority":{
"shape":"RulePriority",
"documentation":"<p>The priority for the rule. A listener can't have multiple rules with the same priority.</p>"
},
"Actions":{
"shape":"Actions",
"documentation":"<p>An action. Each action has the type <code>forward</code> and specifies a target group.</p>"
}
}
},
"CreateRuleOutput":{
"type":"structure",
"members":{
"Rules":{
"shape":"Rules",
"documentation":"<p>Information about the rule.</p>"
}
}
},
"CreateTargetGroupInput":{
"type":"structure",
"required":[
"Name",
"Protocol",
"Port",
"VpcId"
],
"members":{
"Name":{
"shape":"TargetGroupName",
"documentation":"<p>The name of the target group.</p>"
},
"Protocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol to use for routing traffic to the targets.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.</p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The identifier of the virtual private cloud (VPC).</p>"
},
"HealthCheckProtocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol the load balancer uses when performing health checks on targets. The default is the HTTP protocol.</p>"
},
"HealthCheckPort":{
"shape":"HealthCheckPort",
"documentation":"<p>The port the load balancer uses when performing health checks on targets. The default is <code>traffic-port</code>, which indicates the port on which each target receives traffic from the load balancer.</p>"
},
"HealthCheckPath":{
"shape":"Path",
"documentation":"<p>The ping path that is the destination on the targets for health checks. The default is /.</p>"
},
"HealthCheckIntervalSeconds":{
"shape":"HealthCheckIntervalSeconds",
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. The default is 30 seconds.</p>"
},
"HealthCheckTimeoutSeconds":{
"shape":"HealthCheckTimeoutSeconds",
"documentation":"<p>The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.</p>"
},
"HealthyThresholdCount":{
"shape":"HealthCheckThresholdCount",
"documentation":"<p>The number of consecutive health checks successes required before considering an unhealthy target healthy. The default is 5.</p>"
},
"UnhealthyThresholdCount":{
"shape":"HealthCheckThresholdCount",
"documentation":"<p>The number of consecutive health check failures required before considering a target unhealthy. The default is 2.</p>"
},
"Matcher":{
"shape":"Matcher",
"documentation":"<p>The HTTP codes to use when checking for a successful response from a target. The default is 200.</p>"
}
}
},
"CreateTargetGroupOutput":{
"type":"structure",
"members":{
"TargetGroups":{
"shape":"TargetGroups",
"documentation":"<p>Information about the target group.</p>"
}
}
},
"CreatedTime":{"type":"timestamp"},
"DNSName":{"type":"string"},
"DeleteListenerInput":{
"type":"structure",
"required":["ListenerArn"],
"members":{
"ListenerArn":{
"shape":"ListenerArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the listener.</p>"
}
}
},
"DeleteListenerOutput":{
"type":"structure",
"members":{
}
},
"DeleteLoadBalancerInput":{
"type":"structure",
"required":["LoadBalancerArn"],
"members":{
"LoadBalancerArn":{
"shape":"LoadBalancerArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the load balancer.</p>"
}
}
},
"DeleteLoadBalancerOutput":{
"type":"structure",
"members":{
}
},
"DeleteRuleInput":{
"type":"structure",
"required":["RuleArn"],
"members":{
"RuleArn":{
"shape":"RuleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule.</p>"
}
}
},
"DeleteRuleOutput":{
"type":"structure",
"members":{
}
},
"DeleteTargetGroupInput":{
"type":"structure",
"required":["TargetGroupArn"],
"members":{
"TargetGroupArn":{
"shape":"TargetGroupArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the target group.</p>"
}
}
},
"DeleteTargetGroupOutput":{
"type":"structure",
"members":{
}
},
"DeregisterTargetsInput":{
"type":"structure",
"required":[
"TargetGroupArn",
"Targets"
],
"members":{
"TargetGroupArn":{
"shape":"TargetGroupArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the target group.</p>"
},
"Targets":{
"shape":"TargetDescriptions",
"documentation":"<p>The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.</p>"
}
}
},
"DeregisterTargetsOutput":{
"type":"structure",
"members":{
}
},
"DescribeListenersInput":{
"type":"structure",
"members":{
"LoadBalancerArn":{
"shape":"LoadBalancerArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the load balancer.</p>"
},
"ListenerArns":{
"shape":"ListenerArns",
"documentation":"<p>The Amazon Resource Names (ARN) of the listeners.</p>"
},
"Marker":{
"shape":"Marker",
"documentation":"<p>The marker for the next set of results. (You received this marker from a previous call.)</p>"
},
"PageSize":{
"shape":"PageSize",
"documentation":"<p>The maximum number of results to return with this call.</p>"
}
}
},
"DescribeListenersOutput":{
"type":"structure",
"members":{
"Listeners":{
"shape":"Listeners",
"documentation":"<p>Information about the listeners.</p>"
},
"NextMarker":{
"shape":"Marker",
"documentation":"<p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>"
}
}
},
"DescribeLoadBalancerAttributesInput":{
"type":"structure",
"required":["LoadBalancerArn"],
"members":{
"LoadBalancerArn":{
"shape":"LoadBalancerArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the load balancer.</p>"