@aws-sdk/client-elastic-load-balancing 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/dist-types/commands/AddTagsCommand.d.ts +4 -0
  2. package/dist-types/commands/ApplySecurityGroupsToLoadBalancerCommand.d.ts +8 -0
  3. package/dist-types/commands/AttachLoadBalancerToSubnetsCommand.d.ts +8 -0
  4. package/dist-types/commands/ConfigureHealthCheckCommand.d.ts +12 -0
  5. package/dist-types/commands/CreateAppCookieStickinessPolicyCommand.d.ts +4 -0
  6. package/dist-types/commands/CreateLBCookieStickinessPolicyCommand.d.ts +4 -0
  7. package/dist-types/commands/CreateLoadBalancerCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateLoadBalancerListenersCommand.d.ts +4 -0
  9. package/dist-types/commands/CreateLoadBalancerPolicyCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteLoadBalancerCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteLoadBalancerListenersCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteLoadBalancerPolicyCommand.d.ts +4 -0
  13. package/dist-types/commands/DeregisterInstancesFromLoadBalancerCommand.d.ts +10 -0
  14. package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +12 -0
  15. package/dist-types/commands/DescribeInstanceHealthCommand.d.ts +13 -0
  16. package/dist-types/commands/DescribeLoadBalancerAttributesCommand.d.ts +29 -0
  17. package/dist-types/commands/DescribeLoadBalancerPoliciesCommand.d.ts +17 -0
  18. package/dist-types/commands/DescribeLoadBalancerPolicyTypesCommand.d.ts +20 -0
  19. package/dist-types/commands/DescribeLoadBalancersCommand.d.ts +81 -0
  20. package/dist-types/commands/DescribeTagsCommand.d.ts +16 -0
  21. package/dist-types/commands/DetachLoadBalancerFromSubnetsCommand.d.ts +8 -0
  22. package/dist-types/commands/DisableAvailabilityZonesForLoadBalancerCommand.d.ts +8 -0
  23. package/dist-types/commands/EnableAvailabilityZonesForLoadBalancerCommand.d.ts +8 -0
  24. package/dist-types/commands/ModifyLoadBalancerAttributesCommand.d.ts +30 -0
  25. package/dist-types/commands/RegisterInstancesWithLoadBalancerCommand.d.ts +10 -0
  26. package/dist-types/commands/RemoveTagsCommand.d.ts +4 -0
  27. package/dist-types/commands/SetLoadBalancerListenerSSLCertificateCommand.d.ts +4 -0
  28. package/dist-types/commands/SetLoadBalancerPoliciesForBackendServerCommand.d.ts +4 -0
  29. package/dist-types/commands/SetLoadBalancerPoliciesOfListenerCommand.d.ts +4 -0
  30. package/package.json +3 -3
@@ -45,6 +45,8 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
45
45
  * };
46
46
  * const command = new AddTagsCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param AddTagsCommandInput - {@link AddTagsCommandInput}
@@ -62,6 +64,8 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
62
64
  * @throws {@link TooManyTagsException} (client fault)
63
65
  * <p>The quota for the number of tags that can be assigned to a load balancer has been reached.</p>
64
66
  *
67
+ * @throws {@link ElasticLoadBalancingServiceException}
68
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
65
69
  *
66
70
  * @example To add tags to a load balancer
67
71
  * ```javascript
@@ -36,6 +36,12 @@ export interface ApplySecurityGroupsToLoadBalancerCommandOutput extends ApplySec
36
36
  * };
37
37
  * const command = new ApplySecurityGroupsToLoadBalancerCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ApplySecurityGroupsToLoadBalancerOutput
40
+ * // SecurityGroups: [ // SecurityGroups
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // };
44
+ *
39
45
  * ```
40
46
  *
41
47
  * @param ApplySecurityGroupsToLoadBalancerCommandInput - {@link ApplySecurityGroupsToLoadBalancerCommandInput}
@@ -53,6 +59,8 @@ export interface ApplySecurityGroupsToLoadBalancerCommandOutput extends ApplySec
53
59
  * @throws {@link InvalidSecurityGroupException} (client fault)
54
60
  * <p>One or more of the specified security groups do not exist.</p>
55
61
  *
62
+ * @throws {@link ElasticLoadBalancingServiceException}
63
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
56
64
  *
57
65
  * @example To associate a security group with a load balancer in a VPC
58
66
  * ```javascript
@@ -37,6 +37,12 @@ export interface AttachLoadBalancerToSubnetsCommandOutput extends AttachLoadBala
37
37
  * };
38
38
  * const command = new AttachLoadBalancerToSubnetsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // AttachLoadBalancerToSubnetsOutput
41
+ * // Subnets: [ // Subnets
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param AttachLoadBalancerToSubnetsCommandInput - {@link AttachLoadBalancerToSubnetsCommandInput}
@@ -57,6 +63,8 @@ export interface AttachLoadBalancerToSubnetsCommandOutput extends AttachLoadBala
57
63
  * @throws {@link SubnetNotFoundException} (client fault)
58
64
  * <p>One or more of the specified subnets do not exist.</p>
59
65
  *
66
+ * @throws {@link ElasticLoadBalancingServiceException}
67
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
60
68
  *
61
69
  * @example To attach subnets to a load balancer
62
70
  * ```javascript
@@ -40,6 +40,16 @@ export interface ConfigureHealthCheckCommandOutput extends ConfigureHealthCheckO
40
40
  * };
41
41
  * const command = new ConfigureHealthCheckCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // ConfigureHealthCheckOutput
44
+ * // HealthCheck: { // HealthCheck
45
+ * // Target: "STRING_VALUE", // required
46
+ * // Interval: Number("int"), // required
47
+ * // Timeout: Number("int"), // required
48
+ * // UnhealthyThreshold: Number("int"), // required
49
+ * // HealthyThreshold: Number("int"), // required
50
+ * // },
51
+ * // };
52
+ *
43
53
  * ```
44
54
  *
45
55
  * @param ConfigureHealthCheckCommandInput - {@link ConfigureHealthCheckCommandInput}
@@ -51,6 +61,8 @@ export interface ConfigureHealthCheckCommandOutput extends ConfigureHealthCheckO
51
61
  * @throws {@link AccessPointNotFoundException} (client fault)
52
62
  * <p>The specified load balancer does not exist.</p>
53
63
  *
64
+ * @throws {@link ElasticLoadBalancingServiceException}
65
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
54
66
  *
55
67
  * @example To specify the health check settings for your backend EC2 instances
56
68
  * ```javascript
@@ -41,6 +41,8 @@ export interface CreateAppCookieStickinessPolicyCommandOutput extends CreateAppC
41
41
  * };
42
42
  * const command = new CreateAppCookieStickinessPolicyCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param CreateAppCookieStickinessPolicyCommandInput - {@link CreateAppCookieStickinessPolicyCommandInput}
@@ -61,6 +63,8 @@ export interface CreateAppCookieStickinessPolicyCommandOutput extends CreateAppC
61
63
  * @throws {@link TooManyPoliciesException} (client fault)
62
64
  * <p>The quota for the number of policies for this load balancer has been reached.</p>
63
65
  *
66
+ * @throws {@link ElasticLoadBalancingServiceException}
67
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
64
68
  *
65
69
  * @example To generate a stickiness policy for your load balancer
66
70
  * ```javascript
@@ -39,6 +39,8 @@ export interface CreateLBCookieStickinessPolicyCommandOutput extends CreateLBCoo
39
39
  * };
40
40
  * const command = new CreateLBCookieStickinessPolicyCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param CreateLBCookieStickinessPolicyCommandInput - {@link CreateLBCookieStickinessPolicyCommandInput}
@@ -59,6 +61,8 @@ export interface CreateLBCookieStickinessPolicyCommandOutput extends CreateLBCoo
59
61
  * @throws {@link TooManyPoliciesException} (client fault)
60
62
  * <p>The quota for the number of policies for this load balancer has been reached.</p>
61
63
  *
64
+ * @throws {@link ElasticLoadBalancingServiceException}
65
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
62
66
  *
63
67
  * @example To generate a duration-based stickiness policy for your load balancer
64
68
  * ```javascript
@@ -69,6 +69,10 @@ export interface CreateLoadBalancerCommandOutput extends CreateAccessPointOutput
69
69
  * };
70
70
  * const command = new CreateLoadBalancerCommand(input);
71
71
  * const response = await client.send(command);
72
+ * // { // CreateAccessPointOutput
73
+ * // DNSName: "STRING_VALUE",
74
+ * // };
75
+ *
72
76
  * ```
73
77
  *
74
78
  * @param CreateLoadBalancerCommandInput - {@link CreateLoadBalancerCommandInput}
@@ -115,6 +119,8 @@ export interface CreateLoadBalancerCommandOutput extends CreateAccessPointOutput
115
119
  * @throws {@link UnsupportedProtocolException} (client fault)
116
120
  * <p>The specified protocol or signature version is not supported.</p>
117
121
  *
122
+ * @throws {@link ElasticLoadBalancingServiceException}
123
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
118
124
  *
119
125
  * @example To create an HTTP load balancer in a VPC
120
126
  * ```javascript
@@ -42,6 +42,8 @@ export interface CreateLoadBalancerListenersCommandOutput extends CreateLoadBala
42
42
  * };
43
43
  * const command = new CreateLoadBalancerListenersCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // {};
46
+ *
45
47
  * ```
46
48
  *
47
49
  * @param CreateLoadBalancerListenersCommandInput - {@link CreateLoadBalancerListenersCommandInput}
@@ -67,6 +69,8 @@ export interface CreateLoadBalancerListenersCommandOutput extends CreateLoadBala
67
69
  * @throws {@link UnsupportedProtocolException} (client fault)
68
70
  * <p>The specified protocol or signature version is not supported.</p>
69
71
  *
72
+ * @throws {@link ElasticLoadBalancingServiceException}
73
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
70
74
  *
71
75
  * @example To create an HTTP listener for a load balancer
72
76
  * ```javascript
@@ -40,6 +40,8 @@ export interface CreateLoadBalancerPolicyCommandOutput extends CreateLoadBalance
40
40
  * };
41
41
  * const command = new CreateLoadBalancerPolicyCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param CreateLoadBalancerPolicyCommandInput - {@link CreateLoadBalancerPolicyCommandInput}
@@ -63,6 +65,8 @@ export interface CreateLoadBalancerPolicyCommandOutput extends CreateLoadBalance
63
65
  * @throws {@link TooManyPoliciesException} (client fault)
64
66
  * <p>The quota for the number of policies for this load balancer has been reached.</p>
65
67
  *
68
+ * @throws {@link ElasticLoadBalancingServiceException}
69
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
66
70
  *
67
71
  * @example To create a policy that enables Proxy Protocol on a load balancer
68
72
  * ```javascript
@@ -34,6 +34,8 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteAccessPointOutput
34
34
  * };
35
35
  * const command = new DeleteLoadBalancerCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteLoadBalancerCommandInput - {@link DeleteLoadBalancerCommandInput}
@@ -42,6 +44,8 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteAccessPointOutput
42
44
  * @see {@link DeleteLoadBalancerCommandOutput} for command's `response` shape.
43
45
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
44
46
  *
47
+ * @throws {@link ElasticLoadBalancingServiceException}
48
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
45
49
  *
46
50
  * @example To delete a load balancer
47
51
  * ```javascript
@@ -34,6 +34,8 @@ export interface DeleteLoadBalancerListenersCommandOutput extends DeleteLoadBala
34
34
  * };
35
35
  * const command = new DeleteLoadBalancerListenersCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteLoadBalancerListenersCommandInput - {@link DeleteLoadBalancerListenersCommandInput}
@@ -45,6 +47,8 @@ export interface DeleteLoadBalancerListenersCommandOutput extends DeleteLoadBala
45
47
  * @throws {@link AccessPointNotFoundException} (client fault)
46
48
  * <p>The specified load balancer does not exist.</p>
47
49
  *
50
+ * @throws {@link ElasticLoadBalancingServiceException}
51
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
48
52
  *
49
53
  * @example To delete a listener from your load balancer
50
54
  * ```javascript
@@ -32,6 +32,8 @@ export interface DeleteLoadBalancerPolicyCommandOutput extends DeleteLoadBalance
32
32
  * };
33
33
  * const command = new DeleteLoadBalancerPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteLoadBalancerPolicyCommandInput - {@link DeleteLoadBalancerPolicyCommandInput}
@@ -46,6 +48,8 @@ export interface DeleteLoadBalancerPolicyCommandOutput extends DeleteLoadBalance
46
48
  * @throws {@link InvalidConfigurationRequestException} (client fault)
47
49
  * <p>The requested configuration change is not valid.</p>
48
50
  *
51
+ * @throws {@link ElasticLoadBalancingServiceException}
52
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
49
53
  *
50
54
  * @example To delete a policy from your load balancer
51
55
  * ```javascript
@@ -41,6 +41,14 @@ export interface DeregisterInstancesFromLoadBalancerCommandOutput extends Deregi
41
41
  * };
42
42
  * const command = new DeregisterInstancesFromLoadBalancerCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // DeregisterEndPointsOutput
45
+ * // Instances: [ // Instances
46
+ * // { // Instance
47
+ * // InstanceId: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
44
52
  * ```
45
53
  *
46
54
  * @param DeregisterInstancesFromLoadBalancerCommandInput - {@link DeregisterInstancesFromLoadBalancerCommandInput}
@@ -55,6 +63,8 @@ export interface DeregisterInstancesFromLoadBalancerCommandOutput extends Deregi
55
63
  * @throws {@link InvalidEndPointException} (client fault)
56
64
  * <p>The specified endpoint is not valid.</p>
57
65
  *
66
+ * @throws {@link ElasticLoadBalancingServiceException}
67
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
58
68
  *
59
69
  * @example To deregister instances from a load balancer
60
70
  * ```javascript
@@ -34,6 +34,16 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
34
34
  * };
35
35
  * const command = new DescribeAccountLimitsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeAccountLimitsOutput
38
+ * // Limits: [ // Limits
39
+ * // { // Limit
40
+ * // Name: "STRING_VALUE",
41
+ * // Max: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // NextMarker: "STRING_VALUE",
45
+ * // };
46
+ *
37
47
  * ```
38
48
  *
39
49
  * @param DescribeAccountLimitsCommandInput - {@link DescribeAccountLimitsCommandInput}
@@ -42,6 +52,8 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
42
52
  * @see {@link DescribeAccountLimitsCommandOutput} for command's `response` shape.
43
53
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
44
54
  *
55
+ * @throws {@link ElasticLoadBalancingServiceException}
56
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
45
57
  *
46
58
  */
47
59
  export declare class DescribeAccountLimitsCommand extends $Command<DescribeAccountLimitsCommandInput, DescribeAccountLimitsCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
@@ -36,6 +36,17 @@ export interface DescribeInstanceHealthCommandOutput extends DescribeEndPointSta
36
36
  * };
37
37
  * const command = new DescribeInstanceHealthCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeEndPointStateOutput
40
+ * // InstanceStates: [ // InstanceStates
41
+ * // { // InstanceState
42
+ * // InstanceId: "STRING_VALUE",
43
+ * // State: "STRING_VALUE",
44
+ * // ReasonCode: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
39
50
  * ```
40
51
  *
41
52
  * @param DescribeInstanceHealthCommandInput - {@link DescribeInstanceHealthCommandInput}
@@ -50,6 +61,8 @@ export interface DescribeInstanceHealthCommandOutput extends DescribeEndPointSta
50
61
  * @throws {@link InvalidEndPointException} (client fault)
51
62
  * <p>The specified endpoint is not valid.</p>
52
63
  *
64
+ * @throws {@link ElasticLoadBalancingServiceException}
65
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
53
66
  *
54
67
  * @example To describe the health of the instances for a load balancer
55
68
  * ```javascript
@@ -31,6 +31,33 @@ export interface DescribeLoadBalancerAttributesCommandOutput extends DescribeLoa
31
31
  * };
32
32
  * const command = new DescribeLoadBalancerAttributesCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeLoadBalancerAttributesOutput
35
+ * // LoadBalancerAttributes: { // LoadBalancerAttributes
36
+ * // CrossZoneLoadBalancing: { // CrossZoneLoadBalancing
37
+ * // Enabled: true || false, // required
38
+ * // },
39
+ * // AccessLog: { // AccessLog
40
+ * // Enabled: true || false, // required
41
+ * // S3BucketName: "STRING_VALUE",
42
+ * // EmitInterval: Number("int"),
43
+ * // S3BucketPrefix: "STRING_VALUE",
44
+ * // },
45
+ * // ConnectionDraining: { // ConnectionDraining
46
+ * // Enabled: true || false, // required
47
+ * // Timeout: Number("int"),
48
+ * // },
49
+ * // ConnectionSettings: { // ConnectionSettings
50
+ * // IdleTimeout: Number("int"), // required
51
+ * // },
52
+ * // AdditionalAttributes: [ // AdditionalAttributes
53
+ * // { // AdditionalAttribute
54
+ * // Key: "STRING_VALUE",
55
+ * // Value: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // },
59
+ * // };
60
+ *
34
61
  * ```
35
62
  *
36
63
  * @param DescribeLoadBalancerAttributesCommandInput - {@link DescribeLoadBalancerAttributesCommandInput}
@@ -45,6 +72,8 @@ export interface DescribeLoadBalancerAttributesCommandOutput extends DescribeLoa
45
72
  * @throws {@link LoadBalancerAttributeNotFoundException} (client fault)
46
73
  * <p>The specified load balancer attribute does not exist.</p>
47
74
  *
75
+ * @throws {@link ElasticLoadBalancingServiceException}
76
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
48
77
  *
49
78
  * @example To describe the attributes of a load balancer
50
79
  * ```javascript
@@ -38,6 +38,21 @@ export interface DescribeLoadBalancerPoliciesCommandOutput extends DescribeLoadB
38
38
  * };
39
39
  * const command = new DescribeLoadBalancerPoliciesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeLoadBalancerPoliciesOutput
42
+ * // PolicyDescriptions: [ // PolicyDescriptions
43
+ * // { // PolicyDescription
44
+ * // PolicyName: "STRING_VALUE",
45
+ * // PolicyTypeName: "STRING_VALUE",
46
+ * // PolicyAttributeDescriptions: [ // PolicyAttributeDescriptions
47
+ * // { // PolicyAttributeDescription
48
+ * // AttributeName: "STRING_VALUE",
49
+ * // AttributeValue: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // },
53
+ * // ],
54
+ * // };
55
+ *
41
56
  * ```
42
57
  *
43
58
  * @param DescribeLoadBalancerPoliciesCommandInput - {@link DescribeLoadBalancerPoliciesCommandInput}
@@ -52,6 +67,8 @@ export interface DescribeLoadBalancerPoliciesCommandOutput extends DescribeLoadB
52
67
  * @throws {@link PolicyNotFoundException} (client fault)
53
68
  * <p>One or more of the specified policies do not exist.</p>
54
69
  *
70
+ * @throws {@link ElasticLoadBalancingServiceException}
71
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
55
72
  *
56
73
  * @example To describe a policy associated with a load balancer
57
74
  * ```javascript
@@ -40,6 +40,24 @@ export interface DescribeLoadBalancerPolicyTypesCommandOutput extends DescribeLo
40
40
  * };
41
41
  * const command = new DescribeLoadBalancerPolicyTypesCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // DescribeLoadBalancerPolicyTypesOutput
44
+ * // PolicyTypeDescriptions: [ // PolicyTypeDescriptions
45
+ * // { // PolicyTypeDescription
46
+ * // PolicyTypeName: "STRING_VALUE",
47
+ * // Description: "STRING_VALUE",
48
+ * // PolicyAttributeTypeDescriptions: [ // PolicyAttributeTypeDescriptions
49
+ * // { // PolicyAttributeTypeDescription
50
+ * // AttributeName: "STRING_VALUE",
51
+ * // AttributeType: "STRING_VALUE",
52
+ * // Description: "STRING_VALUE",
53
+ * // DefaultValue: "STRING_VALUE",
54
+ * // Cardinality: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // },
58
+ * // ],
59
+ * // };
60
+ *
43
61
  * ```
44
62
  *
45
63
  * @param DescribeLoadBalancerPolicyTypesCommandInput - {@link DescribeLoadBalancerPolicyTypesCommandInput}
@@ -51,6 +69,8 @@ export interface DescribeLoadBalancerPolicyTypesCommandOutput extends DescribeLo
51
69
  * @throws {@link PolicyTypeNotFoundException} (client fault)
52
70
  * <p>One or more of the specified policy types do not exist.</p>
53
71
  *
72
+ * @throws {@link ElasticLoadBalancingServiceException}
73
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
54
74
  *
55
75
  * @example To describe a load balancer policy type defined by Elastic Load Balancing
56
76
  * ```javascript
@@ -35,6 +35,85 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeAccessPoints
35
35
  * };
36
36
  * const command = new DescribeLoadBalancersCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeAccessPointsOutput
39
+ * // LoadBalancerDescriptions: [ // LoadBalancerDescriptions
40
+ * // { // LoadBalancerDescription
41
+ * // LoadBalancerName: "STRING_VALUE",
42
+ * // DNSName: "STRING_VALUE",
43
+ * // CanonicalHostedZoneName: "STRING_VALUE",
44
+ * // CanonicalHostedZoneNameID: "STRING_VALUE",
45
+ * // ListenerDescriptions: [ // ListenerDescriptions
46
+ * // { // ListenerDescription
47
+ * // Listener: { // Listener
48
+ * // Protocol: "STRING_VALUE", // required
49
+ * // LoadBalancerPort: Number("int"), // required
50
+ * // InstanceProtocol: "STRING_VALUE",
51
+ * // InstancePort: Number("int"), // required
52
+ * // SSLCertificateId: "STRING_VALUE",
53
+ * // },
54
+ * // PolicyNames: [ // PolicyNames
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // },
58
+ * // ],
59
+ * // Policies: { // Policies
60
+ * // AppCookieStickinessPolicies: [ // AppCookieStickinessPolicies
61
+ * // { // AppCookieStickinessPolicy
62
+ * // PolicyName: "STRING_VALUE",
63
+ * // CookieName: "STRING_VALUE",
64
+ * // },
65
+ * // ],
66
+ * // LBCookieStickinessPolicies: [ // LBCookieStickinessPolicies
67
+ * // { // LBCookieStickinessPolicy
68
+ * // PolicyName: "STRING_VALUE",
69
+ * // CookieExpirationPeriod: Number("long"),
70
+ * // },
71
+ * // ],
72
+ * // OtherPolicies: [
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // },
76
+ * // BackendServerDescriptions: [ // BackendServerDescriptions
77
+ * // { // BackendServerDescription
78
+ * // InstancePort: Number("int"),
79
+ * // PolicyNames: [
80
+ * // "STRING_VALUE",
81
+ * // ],
82
+ * // },
83
+ * // ],
84
+ * // AvailabilityZones: [ // AvailabilityZones
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // Subnets: [ // Subnets
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // VPCId: "STRING_VALUE",
91
+ * // Instances: [ // Instances
92
+ * // { // Instance
93
+ * // InstanceId: "STRING_VALUE",
94
+ * // },
95
+ * // ],
96
+ * // HealthCheck: { // HealthCheck
97
+ * // Target: "STRING_VALUE", // required
98
+ * // Interval: Number("int"), // required
99
+ * // Timeout: Number("int"), // required
100
+ * // UnhealthyThreshold: Number("int"), // required
101
+ * // HealthyThreshold: Number("int"), // required
102
+ * // },
103
+ * // SourceSecurityGroup: { // SourceSecurityGroup
104
+ * // OwnerAlias: "STRING_VALUE",
105
+ * // GroupName: "STRING_VALUE",
106
+ * // },
107
+ * // SecurityGroups: [ // SecurityGroups
108
+ * // "STRING_VALUE",
109
+ * // ],
110
+ * // CreatedTime: new Date("TIMESTAMP"),
111
+ * // Scheme: "STRING_VALUE",
112
+ * // },
113
+ * // ],
114
+ * // NextMarker: "STRING_VALUE",
115
+ * // };
116
+ *
38
117
  * ```
39
118
  *
40
119
  * @param DescribeLoadBalancersCommandInput - {@link DescribeLoadBalancersCommandInput}
@@ -49,6 +128,8 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeAccessPoints
49
128
  * @throws {@link DependencyThrottleException} (client fault)
50
129
  * <p>A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.</p>
51
130
  *
131
+ * @throws {@link ElasticLoadBalancingServiceException}
132
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
52
133
  *
53
134
  * @example To describe one of your load balancers
54
135
  * ```javascript
@@ -33,6 +33,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat
33
33
  * };
34
34
  * const command = new DescribeTagsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeTagsOutput
37
+ * // TagDescriptions: [ // TagDescriptions
38
+ * // { // TagDescription
39
+ * // LoadBalancerName: "STRING_VALUE",
40
+ * // Tags: [ // TagList
41
+ * // { // Tag
42
+ * // Key: "STRING_VALUE", // required
43
+ * // Value: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param DescribeTagsCommandInput - {@link DescribeTagsCommandInput}
@@ -44,6 +58,8 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat
44
58
  * @throws {@link AccessPointNotFoundException} (client fault)
45
59
  * <p>The specified load balancer does not exist.</p>
46
60
  *
61
+ * @throws {@link ElasticLoadBalancingServiceException}
62
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
47
63
  *
48
64
  * @example To describe the tags for a load balancer
49
65
  * ```javascript
@@ -37,6 +37,12 @@ export interface DetachLoadBalancerFromSubnetsCommandOutput extends DetachLoadBa
37
37
  * };
38
38
  * const command = new DetachLoadBalancerFromSubnetsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DetachLoadBalancerFromSubnetsOutput
41
+ * // Subnets: [ // Subnets
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param DetachLoadBalancerFromSubnetsCommandInput - {@link DetachLoadBalancerFromSubnetsCommandInput}
@@ -51,6 +57,8 @@ export interface DetachLoadBalancerFromSubnetsCommandOutput extends DetachLoadBa
51
57
  * @throws {@link InvalidConfigurationRequestException} (client fault)
52
58
  * <p>The requested configuration change is not valid.</p>
53
59
  *
60
+ * @throws {@link ElasticLoadBalancingServiceException}
61
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
54
62
  *
55
63
  * @example To detach a load balancer from a subnet
56
64
  * ```javascript
@@ -42,6 +42,12 @@ export interface DisableAvailabilityZonesForLoadBalancerCommandOutput extends Re
42
42
  * };
43
43
  * const command = new DisableAvailabilityZonesForLoadBalancerCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // RemoveAvailabilityZonesOutput
46
+ * // AvailabilityZones: [ // AvailabilityZones
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // };
50
+ *
45
51
  * ```
46
52
  *
47
53
  * @param DisableAvailabilityZonesForLoadBalancerCommandInput - {@link DisableAvailabilityZonesForLoadBalancerCommandInput}
@@ -56,6 +62,8 @@ export interface DisableAvailabilityZonesForLoadBalancerCommandOutput extends Re
56
62
  * @throws {@link InvalidConfigurationRequestException} (client fault)
57
63
  * <p>The requested configuration change is not valid.</p>
58
64
  *
65
+ * @throws {@link ElasticLoadBalancingServiceException}
66
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
59
67
  *
60
68
  * @example To disable an Availability Zone for a load balancer
61
69
  * ```javascript
@@ -39,6 +39,12 @@ export interface EnableAvailabilityZonesForLoadBalancerCommandOutput extends Add
39
39
  * };
40
40
  * const command = new EnableAvailabilityZonesForLoadBalancerCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // AddAvailabilityZonesOutput
43
+ * // AvailabilityZones: [ // AvailabilityZones
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // };
47
+ *
42
48
  * ```
43
49
  *
44
50
  * @param EnableAvailabilityZonesForLoadBalancerCommandInput - {@link EnableAvailabilityZonesForLoadBalancerCommandInput}
@@ -50,6 +56,8 @@ export interface EnableAvailabilityZonesForLoadBalancerCommandOutput extends Add
50
56
  * @throws {@link AccessPointNotFoundException} (client fault)
51
57
  * <p>The specified load balancer does not exist.</p>
52
58
  *
59
+ * @throws {@link ElasticLoadBalancingServiceException}
60
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
53
61
  *
54
62
  * @example To enable an Availability Zone for a load balancer
55
63
  * ```javascript
@@ -81,6 +81,34 @@ export interface ModifyLoadBalancerAttributesCommandOutput extends ModifyLoadBal
81
81
  * };
82
82
  * const command = new ModifyLoadBalancerAttributesCommand(input);
83
83
  * const response = await client.send(command);
84
+ * // { // ModifyLoadBalancerAttributesOutput
85
+ * // LoadBalancerName: "STRING_VALUE",
86
+ * // LoadBalancerAttributes: { // LoadBalancerAttributes
87
+ * // CrossZoneLoadBalancing: { // CrossZoneLoadBalancing
88
+ * // Enabled: true || false, // required
89
+ * // },
90
+ * // AccessLog: { // AccessLog
91
+ * // Enabled: true || false, // required
92
+ * // S3BucketName: "STRING_VALUE",
93
+ * // EmitInterval: Number("int"),
94
+ * // S3BucketPrefix: "STRING_VALUE",
95
+ * // },
96
+ * // ConnectionDraining: { // ConnectionDraining
97
+ * // Enabled: true || false, // required
98
+ * // Timeout: Number("int"),
99
+ * // },
100
+ * // ConnectionSettings: { // ConnectionSettings
101
+ * // IdleTimeout: Number("int"), // required
102
+ * // },
103
+ * // AdditionalAttributes: [ // AdditionalAttributes
104
+ * // { // AdditionalAttribute
105
+ * // Key: "STRING_VALUE",
106
+ * // Value: "STRING_VALUE",
107
+ * // },
108
+ * // ],
109
+ * // },
110
+ * // };
111
+ *
84
112
  * ```
85
113
  *
86
114
  * @param ModifyLoadBalancerAttributesCommandInput - {@link ModifyLoadBalancerAttributesCommandInput}
@@ -98,6 +126,8 @@ export interface ModifyLoadBalancerAttributesCommandOutput extends ModifyLoadBal
98
126
  * @throws {@link LoadBalancerAttributeNotFoundException} (client fault)
99
127
  * <p>The specified load balancer attribute does not exist.</p>
100
128
  *
129
+ * @throws {@link ElasticLoadBalancingServiceException}
130
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
101
131
  *
102
132
  * @example To enable cross-zone load balancing
103
133
  * ```javascript
@@ -54,6 +54,14 @@ export interface RegisterInstancesWithLoadBalancerCommandOutput extends Register
54
54
  * };
55
55
  * const command = new RegisterInstancesWithLoadBalancerCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // RegisterEndPointsOutput
58
+ * // Instances: [ // Instances
59
+ * // { // Instance
60
+ * // InstanceId: "STRING_VALUE",
61
+ * // },
62
+ * // ],
63
+ * // };
64
+ *
57
65
  * ```
58
66
  *
59
67
  * @param RegisterInstancesWithLoadBalancerCommandInput - {@link RegisterInstancesWithLoadBalancerCommandInput}
@@ -68,6 +76,8 @@ export interface RegisterInstancesWithLoadBalancerCommandOutput extends Register
68
76
  * @throws {@link InvalidEndPointException} (client fault)
69
77
  * <p>The specified endpoint is not valid.</p>
70
78
  *
79
+ * @throws {@link ElasticLoadBalancingServiceException}
80
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
71
81
  *
72
82
  * @example To register instances with a load balancer
73
83
  * ```javascript
@@ -38,6 +38,8 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea
38
38
  * };
39
39
  * const command = new RemoveTagsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param RemoveTagsCommandInput - {@link RemoveTagsCommandInput}
@@ -49,6 +51,8 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea
49
51
  * @throws {@link AccessPointNotFoundException} (client fault)
50
52
  * <p>The specified load balancer does not exist.</p>
51
53
  *
54
+ * @throws {@link ElasticLoadBalancingServiceException}
55
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
52
56
  *
53
57
  * @example To remove tags from a load balancer
54
58
  * ```javascript
@@ -37,6 +37,8 @@ export interface SetLoadBalancerListenerSSLCertificateCommandOutput extends SetL
37
37
  * };
38
38
  * const command = new SetLoadBalancerListenerSSLCertificateCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param SetLoadBalancerListenerSSLCertificateCommandInput - {@link SetLoadBalancerListenerSSLCertificateCommandInput}
@@ -62,6 +64,8 @@ export interface SetLoadBalancerListenerSSLCertificateCommandOutput extends SetL
62
64
  * @throws {@link UnsupportedProtocolException} (client fault)
63
65
  * <p>The specified protocol or signature version is not supported.</p>
64
66
  *
67
+ * @throws {@link ElasticLoadBalancingServiceException}
68
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
65
69
  *
66
70
  * @example To update the SSL certificate for an HTTPS listener
67
71
  * ```javascript
@@ -45,6 +45,8 @@ export interface SetLoadBalancerPoliciesForBackendServerCommandOutput extends Se
45
45
  * };
46
46
  * const command = new SetLoadBalancerPoliciesForBackendServerCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param SetLoadBalancerPoliciesForBackendServerCommandInput - {@link SetLoadBalancerPoliciesForBackendServerCommandInput}
@@ -62,6 +64,8 @@ export interface SetLoadBalancerPoliciesForBackendServerCommandOutput extends Se
62
64
  * @throws {@link PolicyNotFoundException} (client fault)
63
65
  * <p>One or more of the specified policies do not exist.</p>
64
66
  *
67
+ * @throws {@link ElasticLoadBalancingServiceException}
68
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
65
69
  *
66
70
  * @example To replace the policies associated with a port for a backend instance
67
71
  * ```javascript
@@ -41,6 +41,8 @@ export interface SetLoadBalancerPoliciesOfListenerCommandOutput extends SetLoadB
41
41
  * };
42
42
  * const command = new SetLoadBalancerPoliciesOfListenerCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param SetLoadBalancerPoliciesOfListenerCommandInput - {@link SetLoadBalancerPoliciesOfListenerCommandInput}
@@ -61,6 +63,8 @@ export interface SetLoadBalancerPoliciesOfListenerCommandOutput extends SetLoadB
61
63
  * @throws {@link PolicyNotFoundException} (client fault)
62
64
  * <p>One or more of the specified policies do not exist.</p>
63
65
  *
66
+ * @throws {@link ElasticLoadBalancingServiceException}
67
+ * <p>Base exception class for all service exceptions from ElasticLoadBalancing service.</p>
64
68
  *
65
69
  * @example To replace the policies associated with a listener
66
70
  * ```javascript
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-elastic-load-balancing",
3
3
  "description": "AWS SDK for JavaScript Elastic Load Balancing Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",