@aws-sdk/client-elastic-load-balancing-v2 3.288.0 → 3.290.0

package/dist-types/commands/DescribeListenerCertificatesCommand.d.ts

@@ -36,6 +36,10 @@ export interface DescribeListenerCertificatesCommandOutput extends DescribeListe
  * @see {@link DescribeListenerCertificatesCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link ListenerNotFoundException} (client fault)
+ *  <p>The specified listener does not exist.</p>
+ *
+ *
  */
 export declare class DescribeListenerCertificatesCommand extends $Command<DescribeListenerCertificatesCommandInput, DescribeListenerCertificatesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeListenerCertificatesCommandInput;

package/dist-types/commands/DescribeListenersCommand.d.ts

@@ -31,6 +31,47 @@ export interface DescribeListenersCommandOutput extends DescribeListenersOutput,
  * @see {@link DescribeListenersCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link ListenerNotFoundException} (client fault)
+ *  <p>The specified listener does not exist.</p>
+ *
+ * @throws {@link LoadBalancerNotFoundException} (client fault)
+ *  <p>The specified load balancer does not exist.</p>
+ *
+ * @throws {@link UnsupportedProtocolException} (client fault)
+ *  <p>The specified protocol is not supported.</p>
+ *
+ *
+ * @example To describe a listener
+ * ```javascript
+ * // This example describes the specified listener.
+ * const input = {
+ *   "ListenerArns": [
+ *     "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
+ *   ]
+ * };
+ * const command = new DescribeListenersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Listeners": [
+ *     {
+ *       "DefaultActions": [
+ *         {
+ *           "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
+ *           "Type": "forward"
+ *         }
+ *       ],
+ *       "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
+ *       "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
+ *       "Port": 80,
+ *       "Protocol": "HTTP"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-listeners-1
+ * ```
+ *
  */
 export declare class DescribeListenersCommand extends $Command<DescribeListenersCommandInput, DescribeListenersCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeListenersCommandInput;

package/dist-types/commands/DescribeLoadBalancerAttributesCommand.d.ts

@@ -51,6 +51,47 @@ export interface DescribeLoadBalancerAttributesCommandOutput extends DescribeLoa
  * @see {@link DescribeLoadBalancerAttributesCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link LoadBalancerNotFoundException} (client fault)
+ *  <p>The specified load balancer does not exist.</p>
+ *
+ *
+ * @example To describe load balancer attributes
+ * ```javascript
+ * // This example describes the attributes of the specified load balancer.
+ * const input = {
+ *   "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
+ * };
+ * const command = new DescribeLoadBalancerAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Attributes": [
+ *     {
+ *       "Key": "access_logs.s3.enabled",
+ *       "Value": "false"
+ *     },
+ *     {
+ *       "Key": "idle_timeout.timeout_seconds",
+ *       "Value": "60"
+ *     },
+ *     {
+ *       "Key": "access_logs.s3.prefix",
+ *       "Value": ""
+ *     },
+ *     {
+ *       "Key": "deletion_protection.enabled",
+ *       "Value": "false"
+ *     },
+ *     {
+ *       "Key": "access_logs.s3.bucket",
+ *       "Value": ""
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-load-balancer-attributes-1
+ * ```
+ *
  */
 export declare class DescribeLoadBalancerAttributesCommand extends $Command<DescribeLoadBalancerAttributesCommandInput, DescribeLoadBalancerAttributesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeLoadBalancerAttributesCommandInput;

package/dist-types/commands/DescribeLoadBalancersCommand.d.ts

@@ -29,6 +29,55 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer
  * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link LoadBalancerNotFoundException} (client fault)
+ *  <p>The specified load balancer does not exist.</p>
+ *
+ *
+ * @example To describe a load balancer
+ * ```javascript
+ * // This example describes the specified load balancer.
+ * const input = {
+ *   "LoadBalancerArns": [
+ *     "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
+ *   ]
+ * };
+ * const command = new DescribeLoadBalancersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LoadBalancers": [
+ *     {
+ *       "AvailabilityZones": [
+ *         {
+ *           "SubnetId": "subnet-8360a9e7",
+ *           "ZoneName": "us-west-2a"
+ *         },
+ *         {
+ *           "SubnetId": "subnet-b7d581c0",
+ *           "ZoneName": "us-west-2b"
+ *         }
+ *       ],
+ *       "CanonicalHostedZoneId": "Z2P70J7EXAMPLE",
+ *       "CreatedTime": "2016-03-25T21:26:12.920Z",
+ *       "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com",
+ *       "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
+ *       "LoadBalancerName": "my-load-balancer",
+ *       "Scheme": "internet-facing",
+ *       "SecurityGroups": [
+ *         "sg-5943793c"
+ *       ],
+ *       "State": {
+ *         "Code": "active"
+ *       },
+ *       "Type": "application",
+ *       "VpcId": "vpc-3ac0fb5f"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-load-balancers-1
+ * ```
+ *
  */
 export declare class DescribeLoadBalancersCommand extends $Command<DescribeLoadBalancersCommandInput, DescribeLoadBalancersCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeLoadBalancersCommandInput;

package/dist-types/commands/DescribeRulesCommand.d.ts

@@ -30,6 +30,54 @@ export interface DescribeRulesCommandOutput extends DescribeRulesOutput, __Metad
  * @see {@link DescribeRulesCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link ListenerNotFoundException} (client fault)
+ *  <p>The specified listener does not exist.</p>
+ *
+ * @throws {@link RuleNotFoundException} (client fault)
+ *  <p>The specified rule does not exist.</p>
+ *
+ * @throws {@link UnsupportedProtocolException} (client fault)
+ *  <p>The specified protocol is not supported.</p>
+ *
+ *
+ * @example To describe a rule
+ * ```javascript
+ * // This example describes the specified rule.
+ * const input = {
+ *   "RuleArns": [
+ *     "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"
+ *   ]
+ * };
+ * const command = new DescribeRulesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Rules": [
+ *     {
+ *       "Actions": [
+ *         {
+ *           "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
+ *           "Type": "forward"
+ *         }
+ *       ],
+ *       "Conditions": [
+ *         {
+ *           "Field": "path-pattern",
+ *           "Values": [
+ *             "/img/*"
+ *           ]
+ *         }
+ *       ],
+ *       "IsDefault": false,
+ *       "Priority": "10",
+ *       "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-rules-1
+ * ```
+ *
  */
 export declare class DescribeRulesCommand extends $Command<DescribeRulesCommandInput, DescribeRulesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeRulesCommandInput;

package/dist-types/commands/DescribeSSLPoliciesCommand.d.ts

@@ -31,6 +31,115 @@ export interface DescribeSSLPoliciesCommandOutput extends DescribeSSLPoliciesOut
  * @see {@link DescribeSSLPoliciesCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link SSLPolicyNotFoundException} (client fault)
+ *  <p>The specified SSL policy does not exist.</p>
+ *
+ *
+ * @example To describe a policy used for SSL negotiation
+ * ```javascript
+ * // This example describes the specified policy used for SSL negotiation.
+ * const input = {
+ *   "Names": [
+ *     "ELBSecurityPolicy-2015-05"
+ *   ]
+ * };
+ * const command = new DescribeSSLPoliciesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SslPolicies": [
+ *     {
+ *       "Ciphers": [
+ *         {
+ *           "Name": "ECDHE-ECDSA-AES128-GCM-SHA256",
+ *           "Priority": 1
+ *         },
+ *         {
+ *           "Name": "ECDHE-RSA-AES128-GCM-SHA256",
+ *           "Priority": 2
+ *         },
+ *         {
+ *           "Name": "ECDHE-ECDSA-AES128-SHA256",
+ *           "Priority": 3
+ *         },
+ *         {
+ *           "Name": "ECDHE-RSA-AES128-SHA256",
+ *           "Priority": 4
+ *         },
+ *         {
+ *           "Name": "ECDHE-ECDSA-AES128-SHA",
+ *           "Priority": 5
+ *         },
+ *         {
+ *           "Name": "ECDHE-RSA-AES128-SHA",
+ *           "Priority": 6
+ *         },
+ *         {
+ *           "Name": "DHE-RSA-AES128-SHA",
+ *           "Priority": 7
+ *         },
+ *         {
+ *           "Name": "ECDHE-ECDSA-AES256-GCM-SHA384",
+ *           "Priority": 8
+ *         },
+ *         {
+ *           "Name": "ECDHE-RSA-AES256-GCM-SHA384",
+ *           "Priority": 9
+ *         },
+ *         {
+ *           "Name": "ECDHE-ECDSA-AES256-SHA384",
+ *           "Priority": 10
+ *         },
+ *         {
+ *           "Name": "ECDHE-RSA-AES256-SHA384",
+ *           "Priority": 11
+ *         },
+ *         {
+ *           "Name": "ECDHE-RSA-AES256-SHA",
+ *           "Priority": 12
+ *         },
+ *         {
+ *           "Name": "ECDHE-ECDSA-AES256-SHA",
+ *           "Priority": 13
+ *         },
+ *         {
+ *           "Name": "AES128-GCM-SHA256",
+ *           "Priority": 14
+ *         },
+ *         {
+ *           "Name": "AES128-SHA256",
+ *           "Priority": 15
+ *         },
+ *         {
+ *           "Name": "AES128-SHA",
+ *           "Priority": 16
+ *         },
+ *         {
+ *           "Name": "AES256-GCM-SHA384",
+ *           "Priority": 17
+ *         },
+ *         {
+ *           "Name": "AES256-SHA256",
+ *           "Priority": 18
+ *         },
+ *         {
+ *           "Name": "AES256-SHA",
+ *           "Priority": 19
+ *         }
+ *       ],
+ *       "Name": "ELBSecurityPolicy-2015-05",
+ *       "SslProtocols": [
+ *         "TLSv1",
+ *         "TLSv1.1",
+ *         "TLSv1.2"
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-ssl-policies-1
+ * ```
+ *
  */
 export declare class DescribeSSLPoliciesCommand extends $Command<DescribeSSLPoliciesCommandInput, DescribeSSLPoliciesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeSSLPoliciesCommandInput;

package/dist-types/commands/DescribeTagsCommand.d.ts

@@ -31,6 +31,51 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat
  * @see {@link DescribeTagsCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link ListenerNotFoundException} (client fault)
+ *  <p>The specified listener does not exist.</p>
+ *
+ * @throws {@link LoadBalancerNotFoundException} (client fault)
+ *  <p>The specified load balancer does not exist.</p>
+ *
+ * @throws {@link RuleNotFoundException} (client fault)
+ *  <p>The specified rule does not exist.</p>
+ *
+ * @throws {@link TargetGroupNotFoundException} (client fault)
+ *  <p>The specified target group does not exist.</p>
+ *
+ *
+ * @example To describe the tags assigned to a load balancer
+ * ```javascript
+ * // This example describes the tags assigned to the specified load balancer.
+ * const input = {
+ *   "ResourceArns": [
+ *     "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
+ *   ]
+ * };
+ * const command = new DescribeTagsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagDescriptions": [
+ *     {
+ *       "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
+ *       "Tags": [
+ *         {
+ *           "Key": "project",
+ *           "Value": "lima"
+ *         },
+ *         {
+ *           "Key": "department",
+ *           "Value": "digital-media"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-tags-1
+ * ```
+ *
  */
 export declare class DescribeTagsCommand extends $Command<DescribeTagsCommandInput, DescribeTagsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeTagsCommandInput;

package/dist-types/commands/DescribeTargetGroupAttributesCommand.d.ts

@@ -50,6 +50,43 @@ export interface DescribeTargetGroupAttributesCommandOutput extends DescribeTarg
  * @see {@link DescribeTargetGroupAttributesCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link TargetGroupNotFoundException} (client fault)
+ *  <p>The specified target group does not exist.</p>
+ *
+ *
+ * @example To describe target group attributes
+ * ```javascript
+ * // This example describes the attributes of the specified target group.
+ * const input = {
+ *   "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
+ * };
+ * const command = new DescribeTargetGroupAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Attributes": [
+ *     {
+ *       "Key": "stickiness.enabled",
+ *       "Value": "false"
+ *     },
+ *     {
+ *       "Key": "deregistration_delay.timeout_seconds",
+ *       "Value": "300"
+ *     },
+ *     {
+ *       "Key": "stickiness.type",
+ *       "Value": "lb_cookie"
+ *     },
+ *     {
+ *       "Key": "stickiness.lb_cookie.duration_seconds",
+ *       "Value": "86400"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-target-group-attributes-1
+ * ```
+ *
  */
 export declare class DescribeTargetGroupAttributesCommand extends $Command<DescribeTargetGroupAttributesCommandInput, DescribeTargetGroupAttributesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeTargetGroupAttributesCommandInput;

package/dist-types/commands/DescribeTargetGroupsCommand.d.ts

@@ -32,6 +32,52 @@ export interface DescribeTargetGroupsCommandOutput extends DescribeTargetGroupsO
  * @see {@link DescribeTargetGroupsCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link LoadBalancerNotFoundException} (client fault)
+ *  <p>The specified load balancer does not exist.</p>
+ *
+ * @throws {@link TargetGroupNotFoundException} (client fault)
+ *  <p>The specified target group does not exist.</p>
+ *
+ *
+ * @example To describe a target group
+ * ```javascript
+ * // This example describes the specified target group.
+ * const input = {
+ *   "TargetGroupArns": [
+ *     "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
+ *   ]
+ * };
+ * const command = new DescribeTargetGroupsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TargetGroups": [
+ *     {
+ *       "HealthCheckIntervalSeconds": 30,
+ *       "HealthCheckPath": "/",
+ *       "HealthCheckPort": "traffic-port",
+ *       "HealthCheckProtocol": "HTTP",
+ *       "HealthCheckTimeoutSeconds": 5,
+ *       "HealthyThresholdCount": 5,
+ *       "LoadBalancerArns": [
+ *         "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
+ *       ],
+ *       "Matcher": {
+ *         "HttpCode": "200"
+ *       },
+ *       "Port": 80,
+ *       "Protocol": "HTTP",
+ *       "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
+ *       "TargetGroupName": "my-targets",
+ *       "UnhealthyThresholdCount": 2,
+ *       "VpcId": "vpc-3ac0fb5f"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-target-groups-1
+ * ```
+ *
  */
 export declare class DescribeTargetGroupsCommand extends $Command<DescribeTargetGroupsCommandInput, DescribeTargetGroupsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeTargetGroupsCommandInput;

package/dist-types/commands/DescribeTargetHealthCommand.d.ts

@@ -29,6 +29,89 @@ export interface DescribeTargetHealthCommandOutput extends DescribeTargetHealthO
  * @see {@link DescribeTargetHealthCommandOutput} for command's `response` shape.
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
  *
+ * @throws {@link HealthUnavailableException} (server fault)
+ *  <p>The health of the specified targets could not be retrieved due to an internal
+ *       error.</p>
+ *
+ * @throws {@link InvalidTargetException} (client fault)
+ *  <p>The specified target does not exist, is not in the same VPC as the target group, or has an
+ *       unsupported instance type.</p>
+ *
+ * @throws {@link TargetGroupNotFoundException} (client fault)
+ *  <p>The specified target group does not exist.</p>
+ *
+ *
+ * @example To describe the health of the targets for a target group
+ * ```javascript
+ * // This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.
+ * const input = {
+ *   "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
+ * };
+ * const command = new DescribeTargetHealthCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TargetHealthDescriptions": [
+ *     {
+ *       "Target": {
+ *         "Id": "i-0f76fade",
+ *         "Port": 80
+ *       },
+ *       "TargetHealth": {
+ *         "Description": "Given target group is not configured to receive traffic from ELB",
+ *         "Reason": "Target.NotInUse",
+ *         "State": "unused"
+ *       }
+ *     },
+ *     {
+ *       "HealthCheckPort": "80",
+ *       "Target": {
+ *         "Id": "i-0f76fade",
+ *         "Port": 80
+ *       },
+ *       "TargetHealth": {
+ *         "State": "healthy"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-target-health-1
+ * ```
+ *
+ * @example To describe the health of a target
+ * ```javascript
+ * // This example describes the health of the specified target. This target is healthy.
+ * const input = {
+ *   "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
+ *   "Targets": [
+ *     {
+ *       "Id": "i-0f76fade",
+ *       "Port": 80
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeTargetHealthCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TargetHealthDescriptions": [
+ *     {
+ *       "HealthCheckPort": "80",
+ *       "Target": {
+ *         "Id": "i-0f76fade",
+ *         "Port": 80
+ *       },
+ *       "TargetHealth": {
+ *         "State": "healthy"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: elbv2-describe-target-health-2
+ * ```
+ *
  */
 export declare class DescribeTargetHealthCommand extends $Command<DescribeTargetHealthCommandInput, DescribeTargetHealthCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
     readonly input: DescribeTargetHealthCommandInput;