2017/09/07 - Elastic Load Balancing - 10 updated api methods
{'Protocol': {'TCP'}}
Response {'Listeners': {'Protocol': {'TCP'}}}
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
You can create up to 10 listeners per load balancer.
To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
client.create_listener(
LoadBalancerArn='string',
Protocol='HTTP'|'HTTPS'|'TCP',
Port=123,
SslPolicy='string',
Certificates=[
{
'CertificateArn': 'string'
},
],
DefaultActions=[
{
'Type': 'forward',
'TargetGroupArn': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
string
[REQUIRED]
The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.
integer
[REQUIRED]
The port on which the load balancer is listening.
string
[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
list
[HTTPS listeners] The SSL server certificate. You must provide exactly one certificate.
(dict) --
Information about an SSL server certificate deployed on a load balancer.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
list
[REQUIRED]
The default action for the listener. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.
(dict) --
Information about an action.
Type (string) -- [REQUIRED]
The type of action.
TargetGroupArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the target group.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP',
'Certificates': [
{
'CertificateArn': 'string'
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward',
'TargetGroupArn': 'string'
},
]
},
]
}
Response Structure
(dict) --
Listeners (list) --
Information about the listener.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
(dict) --
Information about an SSL server certificate deployed on a load balancer.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
SslPolicy (string) --
The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
{'SubnetMappings': [{'AllocationId': 'string', 'SubnetId': 'string'}],
'Type': 'application | network'}
Response {'LoadBalancers': {'AvailabilityZones': {'LoadBalancerAddresses': [{'AllocationId': 'string',
'IpAddress': 'string'}]},
'State': {'Code': {'active_impaired'}},
'Type': {'network'}}}
Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.
To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
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 Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide .
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
client.create_load_balancer(
Name='string',
Subnets=[
'string',
],
SubnetMappings=[
{
'SubnetId': 'string',
'AllocationId': 'string'
},
],
SecurityGroups=[
'string',
],
Scheme='internet-facing'|'internal',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Type='application'|'network',
IpAddressType='ipv4'|'dualstack'
)
string
[REQUIRED]
The name of the load balancer.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
list
The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
(string) --
list
The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Network Load Balancers] You can specify one Elastic IP address per subnet.
[Application Load Balancers] You cannot specify Elastic IP addresses for your subnets.
(dict) --
Information about a subnet mapping.
SubnetId (string) --
The ID of the subnet.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address.
list
[Application Load Balancers] The IDs of the security groups to assign to the load balancer.
(string) --
string
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.
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.
The default is an Internet-facing load balancer.
list
One or more tags to assign to the load balancer.
(dict) --
Information about a tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
string
The type of load balancer to create. The default is application .
string
[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4 .
dict
Response Syntax
{
'LoadBalancers': [
{
'LoadBalancerArn': 'string',
'DNSName': 'string',
'CanonicalHostedZoneId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LoadBalancerName': 'string',
'Scheme': 'internet-facing'|'internal',
'VpcId': 'string',
'State': {
'Code': 'active'|'provisioning'|'active_impaired'|'failed',
'Reason': 'string'
},
'Type': 'application'|'network',
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string'
},
]
},
],
'SecurityGroups': [
'string',
],
'IpAddressType': 'ipv4'|'dualstack'
},
]
}
Response Structure
(dict) --
LoadBalancers (list) --
Information about the load balancer.
(dict) --
Information about a load balancer.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
DNSName (string) --
The public DNS name of the load balancer.
CanonicalHostedZoneId (string) --
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
CreatedTime (datetime) --
The date and time the load balancer was created.
LoadBalancerName (string) --
The name of the load balancer.
Scheme (string) --
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.
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.
VpcId (string) --
The ID of the VPC for the load balancer.
State (dict) --
The state of the load balancer.
Code (string) --
The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .
Reason (string) --
A description of the state.
Type (string) --
The type of load balancer.
AvailabilityZones (list) --
The Availability Zones for the load balancer.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet.
LoadBalancerAddresses (list) --
[Network Load Balancers] The static IP address.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address.
SecurityGroups (list) --
The IDs of the security groups for the load balancer.
(string) --
IpAddressType (string) --
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
{'HealthCheckProtocol': {'TCP'}, 'Protocol': {'TCP'}}
Response {'TargetGroups': {'HealthCheckProtocol': {'TCP'}, 'Protocol': {'TCP'}}}
Creates a target group.
To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.
To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.
To delete a target group, use DeleteTargetGroup.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
client.create_target_group(
Name='string',
Protocol='HTTP'|'HTTPS'|'TCP',
Port=123,
VpcId='string',
HealthCheckProtocol='HTTP'|'HTTPS'|'TCP',
HealthCheckPort='string',
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
HealthCheckTimeoutSeconds=123,
HealthyThresholdCount=123,
UnhealthyThresholdCount=123,
Matcher={
'HttpCode': 'string'
},
TargetType='instance'|'ip'
)
string
[REQUIRED]
The name of the target group.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
string
[REQUIRED]
The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.
integer
[REQUIRED]
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.
string
[REQUIRED]
The identifier of the virtual private cloud (VPC).
string
The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.
string
The port the load balancer uses when performing health checks on targets. The default is traffic-port , which is the port on which each target receives traffic from the load balancer.
string
[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.
integer
The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.
integer
The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2 to 60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.
integer
The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.
integer
The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.
dict
[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
HttpCode (string) -- [REQUIRED]
The HTTP codes.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, this is 200 to 399.
string
The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address). The default is instance . Note that you can't specify targets for a target group using both instance IDs and IP addresses.
If the target type is ip , specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP',
'HealthCheckPort': 'string',
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'
},
]
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the target group.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for the health check request.
Matcher (dict) --
The HTTP codes to use when checking for a successful response from a target.
HttpCode (string) --
The HTTP codes.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, this is 200 to 399.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
(string) --
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
{'Listeners': {'Protocol': {'TCP'}}}
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.
See also: AWS API Documentation
Request Syntax
client.describe_listeners(
LoadBalancerArn='string',
ListenerArns=[
'string',
],
Marker='string',
PageSize=123
)
string
The Amazon Resource Name (ARN) of the load balancer.
list
The Amazon Resource Names (ARN) of the listeners.
(string) --
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of results to return with this call.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP',
'Certificates': [
{
'CertificateArn': 'string'
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward',
'TargetGroupArn': 'string'
},
]
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Listeners (list) --
Information about the listeners.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
(dict) --
Information about an SSL server certificate deployed on a load balancer.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
SslPolicy (string) --
The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
NextMarker (string) --
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
{'LoadBalancers': {'AvailabilityZones': {'LoadBalancerAddresses': [{'AllocationId': 'string',
'IpAddress': 'string'}]},
'State': {'Code': {'active_impaired'}},
'Type': {'network'}}}
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
See also: AWS API Documentation
Request Syntax
client.describe_load_balancers(
LoadBalancerArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123
)
list
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
(string) --
list
The names of the load balancers.
(string) --
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of results to return with this call.
dict
Response Syntax
{
'LoadBalancers': [
{
'LoadBalancerArn': 'string',
'DNSName': 'string',
'CanonicalHostedZoneId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LoadBalancerName': 'string',
'Scheme': 'internet-facing'|'internal',
'VpcId': 'string',
'State': {
'Code': 'active'|'provisioning'|'active_impaired'|'failed',
'Reason': 'string'
},
'Type': 'application'|'network',
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string'
},
]
},
],
'SecurityGroups': [
'string',
],
'IpAddressType': 'ipv4'|'dualstack'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
LoadBalancers (list) --
Information about the load balancers.
(dict) --
Information about a load balancer.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
DNSName (string) --
The public DNS name of the load balancer.
CanonicalHostedZoneId (string) --
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
CreatedTime (datetime) --
The date and time the load balancer was created.
LoadBalancerName (string) --
The name of the load balancer.
Scheme (string) --
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.
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.
VpcId (string) --
The ID of the VPC for the load balancer.
State (dict) --
The state of the load balancer.
Code (string) --
The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .
Reason (string) --
A description of the state.
Type (string) --
The type of load balancer.
AvailabilityZones (list) --
The Availability Zones for the load balancer.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet.
LoadBalancerAddresses (list) --
[Network Load Balancers] The static IP address.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address.
SecurityGroups (list) --
The IDs of the security groups for the load balancer.
(string) --
IpAddressType (string) --
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
NextMarker (string) --
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
{'TargetGroups': {'HealthCheckProtocol': {'TCP'}, 'Protocol': {'TCP'}}}
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.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
See also: AWS API Documentation
Request Syntax
client.describe_target_groups(
LoadBalancerArn='string',
TargetGroupArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123
)
string
The Amazon Resource Name (ARN) of the load balancer.
list
The Amazon Resource Names (ARN) of the target groups.
(string) --
list
The names of the target groups.
(string) --
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of results to return with this call.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP',
'HealthCheckPort': 'string',
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the target groups.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for the health check request.
Matcher (dict) --
The HTTP codes to use when checking for a successful response from a target.
HttpCode (string) --
The HTTP codes.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, this is 200 to 399.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
(string) --
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
NextMarker (string) --
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
{'TargetHealthDescriptions': {'TargetHealth': {'State': {'unavailable'}}}}
Describes the health of the specified targets or all of your targets.
See also: AWS API Documentation
Request Syntax
client.describe_target_health(
TargetGroupArn='string',
Targets=[
{
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
list
The targets.
(dict) --
Information about a target.
Id (string) -- [REQUIRED]
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address.
Port (integer) --
The port on which the target is listening.
AvailabilityZone (string) --
The Availability Zone where the IP address is to be registered. Specify all to register an IP address outside the target group VPC with all Availability Zones that are enabled for the load balancer.
If the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional.
This parameter is not supported if the target type of the target group is instance .
dict
Response Syntax
{
'TargetHealthDescriptions': [
{
'Target': {
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
'HealthCheckPort': 'string',
'TargetHealth': {
'State': 'initial'|'healthy'|'unhealthy'|'unused'|'draining'|'unavailable',
'Reason': 'Elb.RegistrationInProgress'|'Elb.InitialHealthChecking'|'Target.ResponseCodeMismatch'|'Target.Timeout'|'Target.FailedHealthChecks'|'Target.NotRegistered'|'Target.NotInUse'|'Target.DeregistrationInProgress'|'Target.InvalidState'|'Target.IpUnusable'|'Elb.InternalError',
'Description': 'string'
}
},
]
}
Response Structure
(dict) --
TargetHealthDescriptions (list) --
Information about the health of the targets.
(dict) --
Information about the health of a target.
Target (dict) --
The description of the target.
Id (string) --
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address.
Port (integer) --
The port on which the target is listening.
AvailabilityZone (string) --
The Availability Zone where the IP address is to be registered. Specify all to register an IP address outside the target group VPC with all Availability Zones that are enabled for the load balancer.
If the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional.
This parameter is not supported if the target type of the target group is instance .
HealthCheckPort (string) --
The port to use to connect with the target.
TargetHealth (dict) --
The health information for the target.
State (string) --
The state of the target.
Reason (string) --
The reason code. If the target state is healthy , a reason code is not provided.
If the target state is initial , the reason code can be one of the following values:
Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.
Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.
If the target state is unhealthy , the reason code can be one of the following values:
Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
Target.Timeout - The health check requests timed out.
Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.
Elb.InternalError - The health checks failed due to an internal error.
If the target state is unused , the reason code can be one of the following values:
Target.NotRegistered - The target is not registered with the target group.
Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
Target.IpUnusable - The target IP address is reserved for use by a load balancer.
Target.InvalidState - The target is in the stopped or terminated state.
If the target state is draining , the reason code can be the following value:
Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.
Description (string) --
A description of the target health that provides additional details. If the state is healthy , a description is not provided.
{'Protocol': {'TCP'}}
Response {'Listeners': {'Protocol': {'TCP'}}}
Modifies the specified properties of the specified listener.
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 and server certificate.
See also: AWS API Documentation
Request Syntax
client.modify_listener(
ListenerArn='string',
Port=123,
Protocol='HTTP'|'HTTPS'|'TCP',
SslPolicy='string',
Certificates=[
{
'CertificateArn': 'string'
},
],
DefaultActions=[
{
'Type': 'forward',
'TargetGroupArn': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
integer
The port for connections from clients to the load balancer.
string
The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.
string
The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide .
list
The SSL server certificate.
(dict) --
Information about an SSL server certificate deployed on a load balancer.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
list
The default action. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.
(dict) --
Information about an action.
Type (string) -- [REQUIRED]
The type of action.
TargetGroupArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the target group.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP',
'Certificates': [
{
'CertificateArn': 'string'
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward',
'TargetGroupArn': 'string'
},
]
},
]
}
Response Structure
(dict) --
Listeners (list) --
Information about the modified listeners.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
(dict) --
Information about an SSL server certificate deployed on a load balancer.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
SslPolicy (string) --
The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
{'HealthCheckProtocol': {'TCP'}}
Response {'TargetGroups': {'HealthCheckProtocol': {'TCP'}, 'Protocol': {'TCP'}}}
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
To monitor the health of the targets, use DescribeTargetHealth.
See also: AWS API Documentation
Request Syntax
client.modify_target_group(
TargetGroupArn='string',
HealthCheckProtocol='HTTP'|'HTTPS'|'TCP',
HealthCheckPort='string',
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
HealthCheckTimeoutSeconds=123,
HealthyThresholdCount=123,
UnhealthyThresholdCount=123,
Matcher={
'HttpCode': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
string
The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP.
string
The port the load balancer uses when performing health checks on targets.
string
[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.
integer
The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.
integer
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
integer
The number of consecutive health checks successes required before considering an unhealthy target healthy.
integer
The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.
dict
[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
HttpCode (string) -- [REQUIRED]
The HTTP codes.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, this is 200 to 399.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP',
'HealthCheckPort': 'string',
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'
},
]
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the target group.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for the health check request.
Matcher (dict) --
The HTTP codes to use when checking for a successful response from a target.
HttpCode (string) --
The HTTP codes.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, this is 200 to 399.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
(string) --
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
{'SubnetMappings': [{'AllocationId': 'string', 'SubnetId': 'string'}]}
Response {'AvailabilityZones': {'LoadBalancerAddresses': [{'AllocationId': 'string',
'IpAddress': 'string'}]}}
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.
Note that you can't change the subnets for a Network Load Balancer.
See also: AWS API Documentation
Request Syntax
client.set_subnets(
LoadBalancerArn='string',
Subnets=[
'string',
],
SubnetMappings=[
{
'SubnetId': 'string',
'AllocationId': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
list
[REQUIRED]
The IDs of the subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
(string) --
list
The IDs of the subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
The load balancer is allocated one static IP address per subnet. You cannot specify your own Elastic IP addresses.
(dict) --
Information about a subnet mapping.
SubnetId (string) --
The ID of the subnet.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address.
dict
Response Syntax
{
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string'
},
]
},
]
}
Response Structure
(dict) --
AvailabilityZones (list) --
Information about the subnet and Availability Zone.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet.
LoadBalancerAddresses (list) --
[Network Load Balancers] The static IP address.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address.