A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. This reference covers Application Load Balancers and Network Load Balancers.
An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
License: Apache 2.0 License
Resources
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
If the certificate in already in the certificate list, the call is successful but the certificate is not added again.
To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener.
For more information, see SSL Certificates in the Application Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - AddListenerCertificates |
|
Certificates
|
array |
The certificate to add. You can specify one certificate per call. Set |
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AddListenerCertificatesOutput
|
object |
Properties
Certificates
|
CertificateList |
Information about the certificates in the certificate list. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyCertificatesException
|
Body
| Name | Data Type | Description |
|---|---|---|
CertificateNotFoundException
|
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
If the certificate in already in the certificate list, the call is successful but the certificate is not added again.
To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener.
For more information, see SSL Certificates in the Application Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - AddListenerCertificates |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Certificates
|
array |
The certificate to add. You can specify one certificate per call. Set |
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AddListenerCertificatesOutput
|
object |
Properties
Certificates
|
CertificateList |
Information about the certificates in the certificate list. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyCertificatesException
|
Body
| Name | Data Type | Description |
|---|---|---|
CertificateNotFoundException
|
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.
To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - AddTags |
|
Tags
|
array |
The tags. Each resource can have a maximum of 10 tags. |
ResourceArns
|
array |
The Amazon Resource Name (ARN) of the resource. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AddTagsOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
DuplicateTagKeysException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTagsException
|
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.
To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - AddTags |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Tags
|
array |
The tags. Each resource can have a maximum of 10 tags. |
ResourceArns
|
array |
The Amazon Resource Name (ARN) of the resource. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AddTagsOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
DuplicateTagKeysException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTagsException
|
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Creates a listener for the specified Application Load Balancer or Network 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.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateListener |
|
DefaultActions
|
array |
The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is [HTTPS listeners] If the action type is [HTTPS listeners] If the action type is [Application Load Balancer] If the action type is [Application Load Balancer] If the action type is |
Certificates
|
array |
[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set To create a certificate list for the listener, use AddListenerCertificates. |
SslPolicy
|
string |
[HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy. |
Port
|
integer Minimum: 1 Maximum: 65535 |
The port on which the load balancer is listening. |
Protocol
|
string Allowed values: - HTTP- HTTPS- TCP- TLS- UDP- TCP_UDP |
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 protocols are TCP, TLS, UDP, and TCP_UDP. |
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateListenerOutput
|
object |
Properties
Listeners
|
Listeners |
Information about the listener. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Examples
{
"Listeners": [
{
"Certificates": [
{
"CertificateArn": "arn:aws:iam::123456789012:server-certificate\/my-server-cert"
}
],
"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": 443,
"Protocol": "HTTPS",
"SslPolicy": "ELBSecurityPolicy-2015-05"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
DuplicateListenerException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyListenersException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyCertificatesException
|
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupAssociationLimitException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
IncompatibleProtocolsException
|
Body
| Name | Data Type | Description |
|---|---|---|
SSLPolicyNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
CertificateNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRegistrationsForTargetIdException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyActionsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidLoadBalancerActionException
|
Creates a listener for the specified Application Load Balancer or Network 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.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateListener |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DefaultActions
|
array |
The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is [HTTPS listeners] If the action type is [HTTPS listeners] If the action type is [Application Load Balancer] If the action type is [Application Load Balancer] If the action type is |
Certificates
|
array |
[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set To create a certificate list for the listener, use AddListenerCertificates. |
SslPolicy
|
string |
[HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy. |
Port
|
integer Minimum: 1 Maximum: 65535 |
The port on which the load balancer is listening. |
Protocol
|
string Allowed values: - HTTP- HTTPS- TCP- TLS- UDP- TCP_UDP |
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 protocols are TCP, TLS, UDP, and TCP_UDP. |
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateListenerOutput
|
object |
Properties
Listeners
|
Listeners |
Information about the listener. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Examples
{
"Listeners": [
{
"Certificates": [
{
"CertificateArn": "arn:aws:iam::123456789012:server-certificate\/my-server-cert"
}
],
"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": 443,
"Protocol": "HTTPS",
"SslPolicy": "ELBSecurityPolicy-2015-05"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
DuplicateListenerException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyListenersException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyCertificatesException
|
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupAssociationLimitException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
IncompatibleProtocolsException
|
Body
| Name | Data Type | Description |
|---|---|---|
SSLPolicyNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
CertificateNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRegistrationsForTargetIdException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyActionsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidLoadBalancerActionException
|
Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, public 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.
For limit 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.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateLoadBalancer |
|
IpAddressType
|
string Allowed values: - ipv4- dualstack |
[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are |
Type
|
string Allowed values: - application- network |
The type of load balancer. The default is |
Tags
|
array |
One or more tags to assign to the load balancer. |
Scheme
|
string Allowed values: - internet-facing- internal |
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. |
SecurityGroups
|
array |
[Application Load Balancers] The IDs of the security groups for the load balancer. |
SubnetMappings
|
array |
The IDs of the public subnets. 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. You cannot specify Elastic IP addresses for your subnets. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer. |
Subnets
|
array |
The IDs of the public subnets. 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. [Network Load Balancers] You can specify subnets from one or more Availability Zones. |
Name
|
string |
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, must not begin or end with a hyphen, and must not begin with "internal-". |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateLoadBalancerOutput
|
object |
Properties
LoadBalancers
|
LoadBalancers |
Information about the load balancer. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"LoadBalancers": [
{
"AvailabilityZones": [
{
"SubnetId": "subnet-8360a9e7",
"ZoneName": "us-west-2a"
},
{
"SubnetId": "subnet-b7d581c0",
"ZoneName": "us-west-2b"
}
],
"CanonicalHostedZoneId": "Z2P70J7EXAMPLE",
"CreatedTime": "2016-03-25T21:29:48.850Z",
"DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com",
"LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer\/app\/my-internal-load-balancer\/5b49b8d4303115c2",
"LoadBalancerName": "my-internal-load-balancer",
"Scheme": "internal",
"SecurityGroups": [
"sg-5943793c"
],
"State": {
"Code": "provisioning"
},
"Type": "application",
"VpcId": "vpc-3ac0fb5f"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
DuplicateLoadBalancerNameException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyLoadBalancersException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
SubnetNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSubnetException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSecurityGroupException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSchemeException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTagsException
|
Body
| Name | Data Type | Description |
|---|---|---|
DuplicateTagKeysException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
AllocationIdNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
AvailabilityZoneNotSupportedException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationNotPermittedException
|
Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, public 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.
For limit 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.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateLoadBalancer |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
IpAddressType
|
string Allowed values: - ipv4- dualstack |
[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are |
Type
|
string Allowed values: - application- network |
The type of load balancer. The default is |
Tags
|
array |
One or more tags to assign to the load balancer. |
Scheme
|
string Allowed values: - internet-facing- internal |
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. |
SecurityGroups
|
array |
[Application Load Balancers] The IDs of the security groups for the load balancer. |
SubnetMappings
|
array |
The IDs of the public subnets. 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. You cannot specify Elastic IP addresses for your subnets. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer. |
Subnets
|
array |
The IDs of the public subnets. 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. [Network Load Balancers] You can specify subnets from one or more Availability Zones. |
Name
|
string |
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, must not begin or end with a hyphen, and must not begin with "internal-". |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateLoadBalancerOutput
|
object |
Properties
LoadBalancers
|
LoadBalancers |
Information about the load balancer. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"LoadBalancers": [
{
"AvailabilityZones": [
{
"SubnetId": "subnet-8360a9e7",
"ZoneName": "us-west-2a"
},
{
"SubnetId": "subnet-b7d581c0",
"ZoneName": "us-west-2b"
}
],
"CanonicalHostedZoneId": "Z2P70J7EXAMPLE",
"CreatedTime": "2016-03-25T21:29:48.850Z",
"DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com",
"LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer\/app\/my-internal-load-balancer\/5b49b8d4303115c2",
"LoadBalancerName": "my-internal-load-balancer",
"Scheme": "internal",
"SecurityGroups": [
"sg-5943793c"
],
"State": {
"Code": "provisioning"
},
"Type": "application",
"VpcId": "vpc-3ac0fb5f"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
DuplicateLoadBalancerNameException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyLoadBalancersException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
SubnetNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSubnetException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSecurityGroupException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSchemeException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTagsException
|
Body
| Name | Data Type | Description |
|---|---|---|
DuplicateTagKeysException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
AllocationIdNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
AvailabilityZoneNotSupportedException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationNotPermittedException
|
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateRule |
|
Actions
|
array |
The actions. Each rule must include exactly one of the following types of actions: If the action type is [HTTPS listeners] If the action type is [HTTPS listeners] If the action type is [Application Load Balancer] If the action type is [Application Load Balancer] If the action type is |
Priority
|
integer Minimum: 1 Maximum: 50000 |
The rule priority. A listener can't have multiple rules with the same priority. |
Conditions
|
array |
The conditions. Each rule can include zero or one of the following conditions: |
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateRuleOutput
|
object |
Properties
Rules
|
Rules |
Information about the rule. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
PriorityInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetGroupsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRulesException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupAssociationLimitException
|
Body
| Name | Data Type | Description |
|---|---|---|
IncompatibleProtocolsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRegistrationsForTargetIdException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetsException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyActionsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidLoadBalancerActionException
|
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateRule |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Actions
|
array |
The actions. Each rule must include exactly one of the following types of actions: If the action type is [HTTPS listeners] If the action type is [HTTPS listeners] If the action type is [Application Load Balancer] If the action type is [Application Load Balancer] If the action type is |
Priority
|
integer Minimum: 1 Maximum: 50000 |
The rule priority. A listener can't have multiple rules with the same priority. |
Conditions
|
array |
The conditions. Each rule can include zero or one of the following conditions: |
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateRuleOutput
|
object |
Properties
Rules
|
Rules |
Information about the rule. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
PriorityInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetGroupsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRulesException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupAssociationLimitException
|
Body
| Name | Data Type | Description |
|---|---|---|
IncompatibleProtocolsException
|
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyRegistrationsForTargetIdException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetsException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyActionsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidLoadBalancerActionException
|
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.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateTargetGroup |
|
TargetType
|
string Allowed values: - instance- ip- lambda |
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
|
Matcher.HttpCode
|
string |
Information to use when checking for a successful response from a target. 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–399. |
UnhealthyThresholdCount
|
integer Minimum: 2 Maximum: 10 |
The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is |
HealthyThresholdCount
|
integer Minimum: 2 Maximum: 10 |
The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is |
HealthCheckTimeoutSeconds
|
integer Minimum: 2 Maximum: 120 |
The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is |
HealthCheckIntervalSeconds
|
integer Minimum: 5 Maximum: 300 |
The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is |
HealthCheckPath
|
string Minimum: 1 Maximum: 1024 |
[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /. |
HealthCheckEnabled
|
boolean |
Indicates whether health checks are enabled. If the target type is |
HealthCheckPort
|
string |
The port the load balancer uses when performing health checks on targets. The default is |
HealthCheckProtocol
|
string Allowed values: - HTTP- HTTPS- TCP- TLS- UDP- TCP_UDP |
The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. |
VpcId
|
string |
The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. |
Port
|
integer Minimum: 1 Maximum: 65535 |
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. |
Protocol
|
string Allowed values: - HTTP- HTTPS- TCP- TLS- UDP- TCP_UDP |
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 protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. |
Name
|
string |
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. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateTargetGroupOutput
|
object |
Properties
TargetGroups
|
TargetGroups |
Information about the target group. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"TargetGroups": [
{
"HealthCheckIntervalSeconds": 30,
"HealthCheckPath": "\/",
"HealthCheckPort": "traffic-port",
"HealthCheckProtocol": "HTTP",
"HealthCheckTimeoutSeconds": 5,
"HealthyThresholdCount": 5,
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
DuplicateTargetGroupNameException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetGroupsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
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.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - CreateTargetGroup |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
TargetType
|
string Allowed values: - instance- ip- lambda |
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
|
Matcher.HttpCode
|
string |
Information to use when checking for a successful response from a target. 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–399. |
UnhealthyThresholdCount
|
integer Minimum: 2 Maximum: 10 |
The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is |
HealthyThresholdCount
|
integer Minimum: 2 Maximum: 10 |
The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is |
HealthCheckTimeoutSeconds
|
integer Minimum: 2 Maximum: 120 |
The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is |
HealthCheckIntervalSeconds
|
integer Minimum: 5 Maximum: 300 |
The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is |
HealthCheckPath
|
string Minimum: 1 Maximum: 1024 |
[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /. |
HealthCheckEnabled
|
boolean |
Indicates whether health checks are enabled. If the target type is |
HealthCheckPort
|
string |
The port the load balancer uses when performing health checks on targets. The default is |
HealthCheckProtocol
|
string Allowed values: - HTTP- HTTPS- TCP- TLS- UDP- TCP_UDP |
The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. |
VpcId
|
string |
The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. |
Port
|
integer Minimum: 1 Maximum: 65535 |
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. |
Protocol
|
string Allowed values: - HTTP- HTTPS- TCP- TLS- UDP- TCP_UDP |
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 protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. |
Name
|
string |
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. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateTargetGroupOutput
|
object |
Properties
TargetGroups
|
TargetGroups |
Information about the target group. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"TargetGroups": [
{
"HealthCheckIntervalSeconds": 30,
"HealthCheckPath": "\/",
"HealthCheckPort": "traffic-port",
"HealthCheckProtocol": "HTTP",
"HealthCheckTimeoutSeconds": 5,
"HealthyThresholdCount": 5,
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
DuplicateTargetGroupNameException
|
Body
| Name | Data Type | Description |
|---|---|---|
TooManyTargetGroupsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationRequestException
|
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteListener |
|
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteListenerOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteListener |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteListenerOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteLoadBalancer |
|
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteLoadBalancerOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationNotPermittedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteLoadBalancer |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteLoadBalancerOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationNotPermittedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Deletes the specified rule.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteRule |
|
RuleArn
|
string |
The Amazon Resource Name (ARN) of the rule. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteRuleOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
RuleNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationNotPermittedException
|
Deletes the specified rule.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteRule |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
RuleArn
|
string |
The Amazon Resource Name (ARN) of the rule. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteRuleOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
RuleNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
OperationNotPermittedException
|
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteTargetGroup |
|
TargetGroupArn
|
string |
The Amazon Resource Name (ARN) of the target group. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteTargetGroupOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeleteTargetGroup |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
TargetGroupArn
|
string |
The Amazon Resource Name (ARN) of the target group. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteTargetGroupOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeregisterTargets |
|
Targets
|
array |
The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it. |
TargetGroupArn
|
string |
The Amazon Resource Name (ARN) of the target group. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeregisterTargetsOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTargetException
|
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DeregisterTargets |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Targets
|
array |
The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it. |
TargetGroupArn
|
string |
The Amazon Resource Name (ARN) of the target group. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeregisterTargetsOutput
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTargetException
|
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeAccountLimits |
|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAccountLimitsOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
|||||||||||||||||
|
|||||||||||||||||||
Limits
|
Limits |
Information about the limits. |
|||||||||||||||||
|
|||||||||||||||||||
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeAccountLimits |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeAccountLimitsOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
|||||||||||||||||
|
|||||||||||||||||||
Limits
|
Limits |
Information about the limits. |
|||||||||||||||||
|
|||||||||||||||||||
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).
For more information, see SSL Certificates in the Application Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeListenerCertificates |
|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
ListenerArn
|
string |
The Amazon Resource Names (ARN) of the listener. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeListenerCertificatesOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
|||||||||||||||||
|
|||||||||||||||||||
Certificates
|
CertificateList |
Information about the certificates. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).
For more information, see SSL Certificates in the Application Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeListenerCertificates |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
ListenerArn
|
string |
The Amazon Resource Names (ARN) of the listener. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeListenerCertificatesOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
|||||||||||||||||
|
|||||||||||||||||||
Certificates
|
CertificateList |
Information about the certificates. |
|||||||||||||||||
|
|||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
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.
For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeListeners |
|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
ListenerArns
|
array |
The Amazon Resource Names (ARN) of the listeners. |
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeListenersOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Listeners
|
Listeners |
Information about the listeners. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
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.
For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeListeners |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
ListenerArns
|
array |
The Amazon Resource Names (ARN) of the listeners. |
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeListenersOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Listeners
|
Listeners |
Information about the listeners. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeLoadBalancerAttributes |
|
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeLoadBalancerAttributesOutput
|
object |
Properties
Attributes
|
LoadBalancerAttributes |
Information about the load balancer attributes. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"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": ""
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeLoadBalancerAttributes |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
LoadBalancerArn
|
string |
The Amazon Resource Name (ARN) of the load balancer. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeLoadBalancerAttributesOutput
|
object |
Properties
Attributes
|
LoadBalancerAttributes |
Information about the load balancer attributes. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"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": ""
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeLoadBalancers |
|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
Names
|
array |
The names of the load balancers. |
LoadBalancerArns
|
array |
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeLoadBalancersOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
LoadBalancers
|
LoadBalancers |
Information about the load balancers. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeLoadBalancers |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
Names
|
array |
The names of the load balancers. |
LoadBalancerArns
|
array |
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeLoadBalancersOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
LoadBalancers
|
LoadBalancers |
Information about the load balancers. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeRules |
|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
RuleArns
|
array |
The Amazon Resource Names (ARN) of the rules. |
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeRulesOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Rules
|
Rules |
Information about the rules. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeRules |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
RuleArns
|
array |
The Amazon Resource Names (ARN) of the rules. |
ListenerArn
|
string |
The Amazon Resource Name (ARN) of the listener. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeRulesOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Rules
|
Rules |
Information about the rules. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedProtocolException
|
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeSSLPolicies |
|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
Names
|
array |
The names of the policies. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeSSLPoliciesOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
||||||||||||||||||||
|
||||||||||||||||||||||
SslPolicies
|
SslPolicies |
Information about the policies. |
||||||||||||||||||||
|
||||||||||||||||||||||
Examples
{
"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"
]
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
SSLPolicyNotFoundException
|
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeSSLPolicies |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
PageSize
|
integer Minimum: 1 Maximum: 400 |
The maximum number of results to return with this call. |
Marker
|
string |
The marker for the next set of results. (You received this marker from a previous call.) |
Names
|
array |
The names of the policies. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeSSLPoliciesOutput
|
object |
Properties
NextMarker
|
Marker |
If there are additional results, this is the marker for the next set of results. Otherwise, this is null. |
||||||||||||||||||||
|
||||||||||||||||||||||
SslPolicies
|
SslPolicies |
Information about the policies. |
||||||||||||||||||||
|
||||||||||||||||||||||
Examples
{
"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"
]
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
SSLPolicyNotFoundException
|
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeTags |
|
ResourceArns
|
array |
The Amazon Resource Names (ARN) of the resources. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTagsOutput
|
object |
Properties
TagDescriptions
|
TagDescriptions |
Information about the tags. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"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"
}
]
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleNotFoundException
|
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeTags |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ResourceArns
|
array |
The Amazon Resource Names (ARN) of the resources. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTagsOutput
|
object |
Properties
TagDescriptions
|
TagDescriptions |
Information about the tags. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"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"
}
]
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
LoadBalancerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetGroupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ListenerNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleNotFoundException
|
Describes the attributes for the specified target group.
For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2015-12-01 |
|
Action
|
string Allowed values: - DescribeTargetGroupAttributes |
|
TargetGroupArn
|
string |
The Amazon Resource Name (ARN) of the target group. |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTargetGroupAttributesOutput
|
object |
Properties
Attributes
|
TargetGroupAttributes |
Information about the target group attributes |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"Attributes": [
{
"Key": "stickiness.enabled",
"Value": "false"
},
{
"Key": "deregistration_delay.time