Elastic Load Balancing. API Reference API Version

Transcription

1 Elastic Load Balancing API Reference

2 Elastic Load Balancing: API Reference Copyright 2014 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. The following are trademarks of Amazon Web Services, Inc.: Amazon, Amazon Web Services Design, AWS, Amazon CloudFront, Cloudfront, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier, Kindle, Kindle Fire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, Amazon VPC. In addition, Amazon.com graphics, logos, page headers, button icons, scripts, and service names are trademarks, or trade dress of Amazon in the U.S. and/or other countries. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

3 Table of Welcome... 1 Actions... 2 AddTags Request Parameters... 3 Errors ApplySecurityGroupsToLoadBalancer Request Parameters... 5 Response Elements... 5 Errors AttachLoadBalancerToSubnets Request Parameters... 7 Response Elements... 7 Errors ConfigureHealthCheck Request Parameters... 9 Response Elements... 9 Errors CreateAppCookieStickinessPolicy Request Parameters Errors CreateLBCookieStickinessPolicy Request Parameters Errors CreateLoadBalancer Request Parameters Response Elements Errors CreateLoadBalancerListeners Request Parameters Errors CreateLoadBalancerPolicy Request Parameters Errors DeleteLoadBalancer Request Parameters DeleteLoadBalancerListeners iii

4 Request Parameters Errors DeleteLoadBalancerPolicy Request Parameters Errors DeregisterInstancesFromLoadBalancer Request Parameters Response Elements Errors DescribeInstanceHealth Request Parameters Response Elements Errors DescribeLoadBalancerAttributes Request Parameters Response Elements Errors DescribeLoadBalancerPolicies Request Parameters Response Elements Errors DescribeLoadBalancerPolicyTypes Request Parameters Response Elements Errors DescribeLoadBalancers Request Parameters Response Elements Errors DescribeTags Request Parameters Response Elements Errors DetachLoadBalancerFromSubnets Request Parameters Response Elements Errors DisableAvailabilityZonesForLoadBalancer Request Parameters iv

5 Response Elements Errors EnableAvailabilityZonesForLoadBalancer Request Parameters Response Elements Errors ModifyLoadBalancerAttributes Request Parameters Response Elements Errors RegisterInstancesWithLoadBalancer Request Parameters Response Elements Errors RemoveTags Request Parameters Errors SetLoadBalancerListenerSSLCertificate Request Parameters Errors SetLoadBalancerPoliciesForBackendServer Request Parameters Errors SetLoadBalancerPoliciesOfListener Request Parameters Errors Data Types AccessLog AddTagsResult AppCookieStickinessPolicy ApplySecurityGroupsToLoadBalancerResult AttachLoadBalancerToSubnetsResult BackendServer v

6 ConfigureHealthCheckResult ConnectionDraining ConnectionSettings CreateAppCookieStickinessPolicyResult CreateLBCookieStickinessPolicyResult CreateLoadBalancerListenersResult CreateLoadBalancerPolicyResult CreateLoadBalancerResult CrossZoneLoadBalancing DeleteLoadBalancerListenersResult DeleteLoadBalancerPolicyResult DeleteLoadBalancerResult DeregisterInstancesFromLoadBalancerResult DescribeInstanceHealthResult DescribeLoadBalancerAttributesResult DescribeLoadBalancerPoliciesResult DescribeLoadBalancerPolicyTypesResult DescribeLoadBalancersResult DescribeTagsResult vi

7 DetachLoadBalancerFromSubnetsResult DisableAvailabilityZonesForLoadBalancerResult EnableAvailabilityZonesForLoadBalancerResult HealthCheck Instance InstanceState LBCookieStickinessPolicy Listener Listener LoadBalancerAttributes LoadBalancer ModifyLoadBalancerAttributesResult Policies PolicyAttribute PolicyAttribute PolicyAttributeType Policy PolicyType RegisterInstancesWithLoadBalancerResult vii

8 RemoveTagsResult SetLoadBalancerListenerSSLCertificateResult SetLoadBalancerPoliciesForBackendServerResult SetLoadBalancerPoliciesOfListenerResult SourceSecurityGroup Tag Tag TagKeyOnly Common Parameters Common Parameters for Signature V4 Signing Common Errors viii

9 Welcome Elastic Load Balancing is a way to automatically distribute incoming web traffic across applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances. You can create, access, and manage Elastic Load Balancing using the AWS Management Console, the AWS Command Line Interface (AWS CLI), the Query API, or the AWS SDKs. For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing. This reference guide contains documentation for the Query API and the AWS CLI commands, to manage Elastic Load Balancing. For detailed information about Elastic Load Balancing features and their associated actions or commands, go to Managing Load Balancers in the Elastic Load Balancing Developer Guide. This reference guide is based on the current WSDL, which is available at: Endpoints The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint. You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference. This document was last updated on August 8,

10 Actions The following actions are supported: AddTags (p. 3) ApplySecurityGroupsToLoadBalancer (p. 5) AttachLoadBalancerToSubnets (p. 7) ConfigureHealthCheck (p. 9) CreateAppCookieStickinessPolicy (p. 11) CreateLBCookieStickinessPolicy (p. 13) CreateLoadBalancer (p. 15) CreateLoadBalancerListeners (p. 22) CreateLoadBalancerPolicy (p. 24) DeleteLoadBalancer (p. 26) DeleteLoadBalancerListeners (p. 27) DeleteLoadBalancerPolicy (p. 28) DeregisterInstancesFromLoadBalancer (p. 29) DescribeInstanceHealth (p. 31) DescribeLoadBalancerAttributes (p. 35) DescribeLoadBalancerPolicies (p. 37) DescribeLoadBalancerPolicyTypes (p. 40) DescribeLoadBalancers (p. 43) DescribeTags (p. 46) DetachLoadBalancerFromSubnets (p. 48) DisableAvailabilityZonesForLoadBalancer (p. 50) EnableAvailabilityZonesForLoadBalancer (p. 52) ModifyLoadBalancerAttributes (p. 54) RegisterInstancesWithLoadBalancer (p. 58) RemoveTags (p. 60) SetLoadBalancerListenerSSLCertificate (p. 62) SetLoadBalancerPoliciesForBackendServer (p. 64) SetLoadBalancerPoliciesOfListener (p. 66) 2

11 AddTags AddTags Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value. Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key. For more information, see Tagging in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerNames.member.N The name of the load balancer to tag. You can specify a maximum of one load balancer name. list Tags.member.N A list of tags for each load balancer. Type: Tag (p. 91) list Length constraints: Minimum of 1 item(s) in the list. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. DuplicateTagKeys The same tag key specified multiple times. TooManyTags The quota for the number of tags that can be assigned to a load balancer has been reached. 3

12 Sample Request &Action=AddTags &Tags.member.1.Key=project &Tags.member.1.Value=lima &Version= &AUTHPARAMS Sample Response <AddTagsResponse xmlns=" 01/"> <AddTagsResult/> <ResponseMetadata> <RequestId>360e81f e4-b6ed-0f30EXAMPLE</RequestId> </ResponseMetadata> </AddTagsResponse> 4

13 ApplySecurityGroupsToLoadBalancer ApplySecurityGroupsToLoadBalancer Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups. For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer.the name must be unique within the set of load balancers associated with your AWS account. SecurityGroups.member.N A list of security group IDs to associate with your load balancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234). list Response Elements The following element is returned in a structure named ApplySecurityGroupsToLoadBalancerResult. SecurityGroups A list of security group IDs associated with your load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 InvalidSecurityGroup One or more specified security groups do not exist. 5

14 Sample Request &LoadBalancerName=my-test-vpc-loadbalancer &Version= &Action=ApplySecurityGroupsToLoadBalancer &AUTHPARAMS Sample Response <ApplySecurityGroupsToLoadBalancerResponse xmlns=" cing.amazonaws.com/doc/ /"> <ApplySecurityGroupsToLoadBalancerResult> <SecurityGroups> <member>sg </member> </SecurityGroups> </ApplySecurityGroupsToLoadBalancerResult> <ResponseMetadata> <RequestId>06b5decc-102a-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </ApplySecurityGroupsToLoadBalancerResponse> 6

15 AttachLoadBalancerToSubnets AttachLoadBalancerToSubnets Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer.the name must be unique within the set of load balancers associated with your AWS account. Subnets.member.N A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone. list Response Elements The following element is returned in a structure named AttachLoadBalancerToSubnetsResult. Subnets A list of subnet IDs attached to the load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 InvalidSubnet The VPC has no Internet gateway. 7

16 SubnetNotFound One or more subnets were not found. Sample Request &LoadBalancerName=my-test-vpc-loadbalancer &Version= &Action=AttachLoadBalancerToSubnets &AUTHPARAMS Sample Response <AttachLoadBalancerToSubnetsResponse xmlns=" aws.com/doc/ /"> <AttachLoadBalancerToSubnetsResult> <Subnets> <member>subnet-119f0078</member> <member>subnet-3561b05e</member> </Subnets> </AttachLoadBalancerToSubnetsResult> <ResponseMetadata> <RequestId>07b1ecbc e3-acaf-dd7edEXAMPLE</RequestId> </ResponseMetadata> </AttachLoadBalancerToSubnetsResponse> 8

17 ConfigureHealthCheck ConfigureHealthCheck Specifies the health check settings to use for evaluating the health state of your back-end instances. For more information, see Health Check in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). HealthCheck A structure containing the configuration information for the new healthcheck. Type: HealthCheck (p. 78) LoadBalancerName The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account. Response Elements The following element is returned in a structure named ConfigureHealthCheckResult. HealthCheck The updated healthcheck for the instances. Type: HealthCheck (p. 78) Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. Sample Request &HealthCheck.UnhealthyThreshold=2 9

18 &LoadBalancerName=MyLoadBalancer &HealthCheck.Target= &HealthCheck.Interval=30 &HealthCheck.Timeout=3 &Version= &Action=ConfigureHealthCheck &AUTHPARAMS Sample Response <ConfigureHealthCheckResponse xmlns=" aws.com/doc/ /"> <ConfigureHealthCheckResult> <HealthCheck> <Interval>30</Interval> <Target> <HealthyThreshold>2</HealthyThreshold> <Timeout>3</Timeout> <UnhealthyThreshold>2</UnhealthyThreshold> </HealthCheck> </ConfigureHealthCheckResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ConfigureHealthCheckResponse> 10

19 CreateAppCookieStickinessPolicy CreateAppCookieStickinessPolicy Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. This policy is similar to the policy created by CreateLBCookieStickinessPolicy (p. 13), except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. Note An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers. For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). CookieName Name of the application cookie used for stickiness. LoadBalancerName The name of the load balancer. PolicyName The name of the policy being created. The name must be unique within the set of policies for this load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. 11

20 DuplicatePolicyName Policy with the same name exists for this load balancer. Please choose another name. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 TooManyPolicies Quota for number of policies for this load balancer has already been reached. Sample Request &LoadBalancerName=MyLoadBalancer &PolicyName=MyAppStickyPolicy &Version= &Action=CreateAppCookieStickinessPolicy &AUTHPARAMS Sample Response <CreateAppCookieStickinessPolicyResponse xmlns=" cing.amazonaws.com/doc/ /"> <CreateAppCookieStickinessPolicyResult/> <ResponseMetadata> <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </CreateAppCookieStickinessPolicyResponse> 12

21 CreateLBCookieStickinessPolicy CreateLBCookieStickinessPolicy Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (useragent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm. A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). CookieExpirationPeriod The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session. Type: Long LoadBalancerName The name associated with the load balancer. PolicyName The name of the policy being created. The name must be unique within the set of policies for this load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. DuplicatePolicyName Policy with the same name exists for this load balancer. Please choose another name. 13

22 InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 TooManyPolicies Quota for number of policies for this load balancer has already been reached. Sample Request &LoadBalancerName=MyLoadBalancer&PolicyName=MyDurationStickyPolicy &Version= &Action=CreateLBCookieStickinessPolicy &AUTHPARAMS Sample Response <CreateLBCookieStickinessPolicyResponse xmlns=" aws.com/doc/ /"> <CreateLBCookieStickinessPolicyResult/> <ResponseMetadata> <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </CreateLBCookieStickinessPolicyResponse> 14

23 CreateLoadBalancer CreateLoadBalancer Creates a new load balancer. After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following: us-east-1.elb.amazonaws.com (for the Northern Virginia region) us-west-1.elb.amazonaws.com (for the Northern California region) For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints. You can create up to 20 load balancers per region per account. Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms: EC2-Classic For information on creating and managing your load balancers in EC2-Classic, see Deploy Elastic Load Balancing in Amazon EC2-Classic. EC2-VPC For information on creating and managing your load balancers in EC2-VPC, see Deploy Elastic Load Balancing in Amazon VPC. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). AvailabilityZones.member.N A list of Availability Zones. At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones. You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer (p. 52) action. list Listeners.member.N A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId. Type: Listener (p. 81) list 15

24 Response Elements LoadBalancerName The name associated with the load balancer. The name must be unique within your set of load balancers, must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens. Scheme The type of a load balancer. By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers. Specify the value internal for this option to create an internal load balancer with a DNS name that resolves to private IP addresses. Note This option is only available for load balancers created within EC2-VPC. SecurityGroups.member.N The security groups to assign to your load balancer within your VPC. list Subnets.member.N A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone. list Tags.member.N A list of tags to assign to the load balancer. For more information about setting tags for your load balancer, see Tagging. Type: Tag (p. 91) list Length constraints: Minimum of 1 item(s) in the list. Response Elements The following element is returned in a structure named CreateLoadBalancerResult. DNSName The DNS name for the load balancer. 16

25 Errors Errors For information about the errors that are common to all actions, see Common Errors (p. 97). CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service. DuplicateAccessPointName The load balancer name already exists for this account. Please choose another name. DuplicateTagKeys The same tag key specified multiple times. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 InvalidScheme Invalid value for scheme. Scheme can only be specified for load balancers in VPC. InvalidSecurityGroup One or more specified security groups do not exist. InvalidSubnet The VPC has no Internet gateway. SubnetNotFound One or more subnets were not found. TooManyAccessPoints The quota for the number of load balancers has already been reached. TooManyTags The quota for the number of tags that can be assigned to a load balancer has been reached. 17

26 Create a TCP Load Balancer in EC2-Classic Sample Request &AvailabilityZones.member.1=us-east-1c &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-test-loadbalancer us-east-1.elb.amazonaws.com</DNS Name> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create an HTTPS Load Balancer in EC2-Classic Sample Request &AvailabilityZones.member.1=us-east-1c &Listeners.member.1.LoadBalancerPort=443 &Listeners.member.1.InstancePort=443 &Listeners.member.1.Protocol=https &Listeners.member.1.InstanceProtocol=https &Listeners.member.1.SSLCertificateId=arn:aws:iam:: :server-certific ate/servercert &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>MyHTTPSLoadBalancer us-east-1.elb.amazonaws.com</DNSName> 18

27 </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in EC2-VPC Sample Request &LoadBalancerName=MyVPCLoadBalancer &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Subnets.member.1=subnet-6dec9f03 &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>MyVPCLoadBalancer us-east-1.elb.amazonaws.com</DNSName> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create an Internal TCP Load Balancer in EC2-VPC Sample Request &SecurityGroups.member.1=sg-706cb61f &LoadBalancerName=MyInternalLoadBalancer &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Subnets.member.1=subnet-9edc97f0 &Version= &Action=CreateLoadBalancer &AUTHPARAMS 19

28 Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>internal-MyInternalLoadBalancer us-east-1.elb.amazon aws.com</dnsname> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in a Default VPC Sample Request Balancer &AvailabilityZones.member.1=sa-east-1b &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>MyDefaultVPCLoadBalancer sa.east-1.elb.amazonaws.com</DNS Name> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in EC2-Classic and Assign a Tag Sample Request &AvailabilityZones.member.1=us-east-1c; &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 20

29 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Tags.member.1.Value=digital-media &Tags.member.1.Key=department &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-test-loadbalancer us-east-1.elb.amazonaws.com</DNS Name> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> 21

30 CreateLoadBalancerListeners CreateLoadBalancerListeners Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener. For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Listeners.member.N A list of LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and SSLCertificateId items. Type: Listener (p. 81) list LoadBalancerName The name of the load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service. DuplicateListener A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code:

31 Sample Request &Listeners.member.1.LoadBalancerPort=443 &Listeners.member.1.InstancePort=443 &Listeners.member.1.InstanceProtocol=https &Listeners.member.1.SSLCertificateId=arn:aws:iam:: :server-certific ate/servercert &LoadBalancerName=MyHTTPSLoadBalancer &Version= &Action=CreateLoadBalancerListeners &AUTHPARAMS Sample Response <CreateLoadBalancerListenersResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerListenersResult/> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerListenersResponse> 23

32 CreateLoadBalancerPolicy CreateLoadBalancerPolicy Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your load balancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the LoadBalancer for which the policy is being created. PolicyAttributes.member.N A list of attributes associated with the policy being created. Type: PolicyAttribute (p. 86) list PolicyName The name of the load balancer policy being created. The name must be unique within the set of policies for this load balancer. PolicyTypeName The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes (p. 40) action. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. DuplicatePolicyName Policy with the same name exists for this load balancer. Please choose another name. InvalidConfigurationRequest Requested configuration change is invalid. 24

33 HTTP Status Code: 409 PolicyTypeNotFound One or more of the specified policy types do not exist. TooManyPolicies Quota for number of policies for this load balancer has already been reached. Sample Request Name=ProxyProtocol &PolicyAttributes.member.1.AttributeValue=true &PolicyTypeName=ProxyProtocolPolicyType &LoadBalancerName=my-test-loadbalancer &PolicyName=EnableProxyProtocol &Version= &Action=CreateLoadBalancerPolicy &AUTHPARAMS Sample Response <CreateLoadBalancerPolicyResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerPolicyResult/> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerPolicyResponse> 25

34 DeleteLoadBalancer DeleteLoadBalancer Deletes the specified load balancer. If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances. To successfully call this API, you must provide the same account credentials as were used to create the load balancer. Note By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoad- Balancer action still succeeds. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer. 26

35 DeleteLoadBalancerListeners DeleteLoadBalancerListeners Deletes listeners from the load balancer for the specified port. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The mnemonic name associated with the load balancer. LoadBalancerPorts.member.N The client port number(s) of the load balancer listener(s) to be removed. Type: Integer list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. 27

36 DeleteLoadBalancerPolicy DeleteLoadBalancerPolicy Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The mnemonic name associated with the load balancer. PolicyName The mnemonic name for the policy being deleted. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code:

37 DeregisterInstancesFromLoadBalancer DeregisterInstancesFromLoadBalancer Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer. In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided. For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide. You can use DescribeLoadBalancers (p. 43) to verify if the instance is deregistered from the load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Instances.member.N A list of EC2 instance IDs consisting of all instances to be deregistered. Type: Instance (p. 79) list LoadBalancerName The name associated with the load balancer. Response Elements The following element is returned in a structure named DeregisterInstancesFromLoadBalancer- Result. Instances An updated list of remaining instances registered with the load balancer. Type: Instance (p. 79) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidEndPoint The specified EndPoint is not valid. 29

38 Deregister instance i-e3677ad7 from MyHTTPSLoadBalancer load balancer. Sample Request &LoadBalancerName=MyHTTPSLoadBalancer &Version= &Action=DeregisterInstancesFromLoadBalancer &AUTHPARAMS Sample Response <DeregisterInstancesFromLoadBalancerResponse xmlns=" cing.amazonaws.com/doc/ /"> <DeregisterInstancesFromLoadBalancerResult> <Instances> <member> <InstanceId>i-6ec63d59</InstanceId> </member> </Instances> </DeregisterInstancesFromLoadBalancerResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DeregisterInstancesFromLoadBalancerResponse> 30

39 DescribeInstanceHealth DescribeInstanceHealth Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned. Note You must provide the same account credentials as those that were used to create the load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Instances.member.N A list of instance IDs whose states are being queried. Type: Instance (p. 79) list LoadBalancerName The name of the load balancer. Response Elements The following element is returned in a structure named DescribeInstanceHealthResult. InstanceStates A list containing health information for the specified instances. Type: InstanceState (p. 80) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidEndPoint The specified EndPoint is not valid. 31

40 of a healthy (InService) instance Sample Request &Version= &Action=DescribeInstanceHealth &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> <InstanceStates> <member> <>N/A</> <InstanceId>i-90d8c2a5</InstanceId> <State>InService</State> <ReasonCode>N/A</ReasonCode> </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> of an instance with registration in progress Sample Request &Version= &Action=DescribeInstanceHealth &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> <InstanceStates> <member> <>Instance registration is still in progress.</> <InstanceId>i-315b7e51</InstanceId> <State>OutOfService</State> <ReasonCode>ELB</ReasonCode> 32

41 </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> of an unhealthy (OutOfService) instance Sample Request &Version= &Action=DescribeInstanceHealth &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> <InstanceStates> <member> <>Instance has failed at least the UnhealthyThreshold number of health checks consecutively.</> <InstanceId>i-fda142c9</InstanceId> <State>OutOfService</State> <ReasonCode>Instance</ReasonCode> </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> of an instance in an unknown state Sample Request &Version= &Action=DescribeInstanceHealth &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> 33

42 <DescribeInstanceHealthResult> <InstanceStates> <member> <>A transient error occurred. Please try again later.</de scription> <InstanceId>i-7f12e649</InstanceId> <State>Unknown</State> <ReasonCode>ELB</ReasonCode> </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> 34

43 DescribeLoadBalancerAttributes DescribeLoadBalancerAttributes Returns detailed information about all of the attributes associated with the specified load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name of the load balancer. Response Elements The following element is returned in a structure named DescribeLoadBalancerAttributesResult. LoadBalancerAttributes The load balancer attributes structure. Type: LoadBalancerAttributes (p. 82) Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. LoadBalancerAttributeNotFound The specified load balancer attribute could not be found. Sample Request &Version= &Action=DescribeLoadBalancerAttributes &AUTHPARAMS 35

44 Sample Response <DescribeLoadBalancerAttributesResponse xmlns=" cing.amazonaws.com/doc/ /"> <DescribeLoadBalancerAttributesResult> <LoadBalancerAttributes> <AccessLog> <Enabled>true</Enabled> <S3BucketName>my-loadbalancer-logs</S3BucketName> <S3BucketPrefix>testprefix</S3BucketPrefix> <EmitInterval>5</EmitInterval> </AccessLog> <ConnectionSettings> <IdleTimeout>30</IdleTimeout> </ConnectionSettings> <CrossZoneLoadBalancing> <Enabled>true</Enabled> </CrossZoneLoadBalancing> <ConnectionDraining> <Enabled>true</Enabled> <Timeout>60</Timeout> </ConnectionDraining> </LoadBalancerAttributes> </DescribeLoadBalancerAttributesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerAttributesResponse> 36

45 DescribeLoadBalancerPolicies DescribeLoadBalancerPolicies Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The mnemonic name associated with the load balancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices. PolicyNames.member.N The names of load balancer policies you've created or Elastic Load Balancing sample policy names. list Response Elements The following element is returned in a structure named DescribeLoadBalancerPoliciesResult. Policys A list of policy description structures. Type: Policy (p. 88) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. PolicyNotFound One or more specified policies were not found. 37

46 of all the policies associated with a load balancer Sample Request &Version= &Action=DescribeLoadBalancerPolicies &AUTHPARAMS Sample Response <DescribeLoadBalancerPoliciesResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancerPoliciesResult> <Policys> <member> <PolicyName>MyDurationStickyPolicy</PolicyName> <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributes> <member> <AttributeName>CookieExpirationPeriod</AttributeName> <AttributeValue>60</AttributeValue> </member> </PolicyAttributes> </member> <member> <PolicyName>MyAppStickyPolicy</PolicyName> <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributes> <member> <AttributeName>CookieName</AttributeName> <AttributeValue>MyAppCookie</AttributeValue> </member> </PolicyAttributes> </member> </Policys> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse> of a specified policy associated with the load balancer Sample Request tocol 38

47 &LoadBalancerName=my-test-loadbalancer &Version= &Action=DescribeLoadBalancerPolicies &AUTHPARAMS Sample Response <DescribeLoadBalancerPoliciesResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancerPoliciesResult> <Policys> <member> <PolicyName>EnableProxyProtocol</PolicyName> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <PolicyAttributes> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeValue>true</AttributeValue> </member> </PolicyAttributes> </member> </Policys> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse> 39

48 DescribeLoadBalancerPolicyTypes DescribeLoadBalancerPolicyTypes Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancer- Policy (p. 24) action to instantiate specific policy configurations that will be applied to a load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). PolicyTypeNames.member.N Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. list Response Elements The following element is returned in a structure named DescribeLoadBalancerPolicyTypesResult. PolicyTypes List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. Type: PolicyType (p. 89) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). PolicyTypeNotFound One or more of the specified policy types do not exist. Partial description of all the policy types defined by Elastic Load Balancing for your account Sample Request &Action=DescribeLoadBalancerPolicyTypes &AUTHPARAMS 40

49 Sample Response <DescribeLoadBalancerPolicyTypesResponse xmlns=" cing.amazonaws.com/doc/ /"> <DescribeLoadBalancerPolicyTypesResult> <PolicyTypeName>SSLNegotiationPolicyType</PolicyTypeName> <....> <PolicyTypeName>BackendServerAuthenticationPolicyType</PolicyTypeName> <....> <PolicyTypeName>PublicKeyPolicyType</PolicyTypeName> <....> <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName> <....> <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName> <....> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <....> </DescribeLoadBalancerPolicyTypesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ DescribeLoadBalancerPolicyTypesResponse > of ProxyProtocolPolicyType Sample Request tocolpolicytype &Version= &Action=DescribeLoadBalancerPolicyTypes &AUTHPARAMS Sample Response <DescribeLoadBalancerPolicyTypesResponse xmlns=" cing.amazonaws.com/doc/ /"> <DescribeLoadBalancerPolicyTypesResult> <PolicyTypes> <member> <PolicyAttributeTypes> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeType>Boolean</AttributeType> <Cardinality>ONE</Cardinality> </member> </PolicyAttributeTypes> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <>Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP/SSL listeners only</> </member> </PolicyTypes> </DescribeLoadBalancerPolicyTypesResult> 41

50 <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPolicyTypesResponse> 42

51 DescribeLoadBalancers DescribeLoadBalancers Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers. Note In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerNames.member.N A list of load balancer names associated with the account. list Marker An optional parameter used for pagination of results from this call. If specified, the response includes only records beyond the marker. PageSize The number of results returned in each page. The default is 400. You cannot specify a page size greater than 400 or less than 1. Type: Integer Response Elements The following elements are returned in a structure named DescribeLoadBalancersResult. LoadBalancers A list of load balancer description structures. Type: LoadBalancer (p. 83) list NextMarker Specifies the value of next marker if the request returned more than one page of results. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). 43

52 AccessPointNotFound The specified load balancer could not be found. of a specified load balancer Sample Request Balancer &Version= &Action=DescribeLoadBalancers &AUTHPARAMS Sample Response <DescribeLoadBalancersResult> <LoadBalancers> <member> <SecurityGroups/> <LoadBalancerName>MyLoadBalancer</LoadBalancerName> <CreatedTime> T21:15:31.280Z</CreatedTime> <HealthCheck> <Interval>90</Interval> <Target> <HealthyThreshold>2</HealthyThreshold> <Timeout>60</Timeout> <UnhealthyThreshold>10</UnhealthyThreshold> </HealthCheck> <Listeners> <member> <PolicyNames/> <Listener> <Protocol>HTTP</Protocol> <LoadBalancerPort>80</LoadBalancerPort> <InstanceProtocol>HTTP</InstanceProtocol> <InstancePort>80</InstancePort> </Listener> </member> </Listeners> <Instances> <member> <InstanceId>i-e4cbe38d</InstanceId> </member> </Instances> <Policies> <AppCookieStickinessPolicies/> <OtherPolicies/> <LBCookieStickinessPolicies/> </Policies> <AvailabilityZones> 44

53 <member>us-east-1a</member> </AvailabilityZones> <CanonicalHostedZoneNameID>ZZZZZZZZZZZ123X</CanonicalHostedZoneNameID> <CanonicalHostedZoneName>MyLoadBalancer us-east- 1.elb.amazonaws.com</CanonicalHostedZoneName> <Scheme>internet-facing</Scheme> <SourceSecurityGroup> <OwnerAlias>amazon-elb</OwnerAlias> <GroupName>amazon-elb-sg</GroupName> </SourceSecurityGroup> <DNSName>MyLoadBalancer us-east-1.elb.amazonaws.com</DNSName> <BackendServers/> <Subnets/> </member> </LoadBalancers> </DescribeLoadBalancersResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ DescribeLoadBalancerPolicyTypesResponse > 45

54 DescribeTags DescribeTags Describes the tags associated with one or more load balancers. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerNames.member.N The names of the load balancers. list Length constraints: Minimum of 1 item(s) in the list. Maximum of 20 item(s) in the list. Response Elements The following element is returned in a structure named DescribeTagsResult. Tags A list of tag description structures. Type: Tag (p. 91) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. Sample Request &LoadBalancerNames.member.1=my-test-loadbalancer &Version= &AUTHPARAMS 46

55 Sample Response <DescribeTagsResponse xmlns=" <DescribeTagsResult> <Tags> <member> <Tags> <Value>lima</Value> <Key>project</Key> </member> <member> <Value>digital-media</Value> <Key>department</Key> </member> </Tags> <LoadBalancerName>my-test-loadbalancer</LoadBalancerName> </member> </Tags> <ResponseMetadata> <RequestId>07b1ecbc e3-acaf-dd7edEXAMPLE</RequestId> </ResponseMetadata> </DescribeTagsResponse> 47

56 DetachLoadBalancerFromSubnets DetachLoadBalancerFromSubnets Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer to be detached. Subnets.member.N A list of subnet IDs to remove from the set of configured subnets for the load balancer. list Response Elements The following element is returned in a structure named DetachLoadBalancerFromSubnetsResult. Subnets A list of subnet IDs the load balancer is now attached to. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code:

57 Sample Request &LoadBalancerName=my-test-vpc-loadbalancer &Version= &Action=DetachLoadBalancerFromSubnets &AUTHPARAMS Sample Response <DetachLoadBalancerFromSubnetsResponse xmlns=" aws.com/doc/ /"> <DetachLoadBalancerFromSubnetsResult> <Subnets> <member>subnet-159f007c</member> <member>subnet-3561b05e</member> </Subnets> </DetachLoadBalancerFromSubnetsResult> <ResponseMetadata> <RequestId>07b1ecbc e3-acaf-dd7edEXAMPLE</RequestId> </ResponseMetadata> </DetachLoadBalancerFromSubnetsResponse> 49

58 DisableAvailabilityZonesForLoadBalancer DisableAvailabilityZonesForLoadBalancer Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer. There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing. For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). AvailabilityZones.member.N A list of Availability Zones to be removed from the load balancer. Note There must be at least one Availability Zone registered with a load balancer at all times. Specified Availability Zones must be in the same region. list LoadBalancerName The name associated with the load balancer. Response Elements The following element is returned in a structure named DisableAvailabilityZonesForLoadBalancerResult. AvailabilityZones A list of updated Availability Zones for the load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. 50

59 InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 Sample Request 1a &LoadBalancerName=MyHTTPSLoadBalancer &Version= &Action=DisableAvailabilityZonesForLoadBalancer &AUTHPARAMS Sample Response <DisableAvailabilityZonesForLoadBalancerResponse xmlns=" ancing.amazonaws.com/doc/ /"> <DisableAvailabilityZonesForLoadBalancerResult> <AvailabilityZones> <member>us-east-1b</member> </AvailabilityZones> </DisableAvailabilityZonesForLoadBalancerResult> <ResponseMetadata> <RequestId>ba6267d e3-9c6d-eb728EXAMPLE</RequestId> </ResponseMetadata> </DisableAvailabilityZonesForLoadBalancerResponse> 51

60 EnableAvailabilityZonesForLoadBalancer EnableAvailabilityZonesForLoadBalancer Adds one or more EC2 Availability Zones to the load balancer. The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. Note The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created. For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). AvailabilityZones.member.N A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer. list LoadBalancerName The name associated with the load balancer. Response Elements The following element is returned in a structure named EnableAvailabilityZonesForLoadBalancerResult. AvailabilityZones An updated list of Availability Zones for the load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. 52

61 Enable Availability Zone us-east-1c for my-test-loadbalancer. Sample Request 1c &LoadBalancerName=my-test-loadbalancer &Version= &Action=EnableAvailabilityZonesForLoadBalancer &AUTHPARAMS Sample Response <EnableAvailabilityZonesForLoadBalancerResponse xmlns=" cing.amazonaws.com/doc/ /"> <EnableAvailabilityZonesForLoadBalancerResult> <AvailabilityZones> <member>us-east-1a</member> <member>us-east-1c</member> </AvailabilityZones> </EnableAvailabilityZonesForLoadBalancerResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </EnableAvailabilityZonesForLoadBalancerResponse> 53

62 ModifyLoadBalancerAttributes ModifyLoadBalancerAttributes Modifies the attributes of a specified load balancer. You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer. For more information, see the following: Cross-Zone Load Balancing Connection Draining Access Logs Idle Connection Timeout Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerAttributes Attributes of the load balancer. Type: LoadBalancerAttributes (p. 82) LoadBalancerName The name of the load balancer. Response Elements The following elements are returned in a structure named ModifyLoadBalancerAttributesResult. LoadBalancerAttributes The LoadBalancerAttributes data type. Type: LoadBalancerAttributes (p. 82) LoadBalancerName The name of the load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). 54

63 AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 LoadBalancerAttributeNotFound The specified load balancer attribute could not be found. Enable Cross-Zone Load Balancing Sample Request &LoadBalancerAttributes.CrossZoneLoadBalancing.Enabled=true &Version= &Action=ModifyLoadBalancerAttributes &AUTHPARAMS Sample Response <<ModifyLoadBalancerAttributesResponse xmlns=" aws.com/doc/ /"> <ModifyLoadBalancerAttributesResult> <LoadBalancerName>my-test-loadbalancer</LoadBalancerName> <LoadBalancerAttributes> <CrossZoneLoadBalancing> <Enabled>true</Enabled> </CrossZoneLoadBalancing> </LoadBalancerAttributes> </ModifyLoadBalancerAttributesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ModifyLoadBalancerAttributesResponse> Enable Access Log Sample Request &LoadBalancerAttributes.AccessLog.Enabled=true &LoadBalancerAttributes.AccessLog.S3BucketName=my-loadbalancer-logs &LoadBalancerAttributes.AccessLog.S3BucketPrefix=my-bucket-prefix/prod 55

64 &LoadBalancerAttributes.AccessLog.EmitInterval=60 &Version= &Action=ModifyLoadBalancerAttributes &AUTHPARAMS Sample Response <<ModifyLoadBalancerAttributesResponse xmlns=" aws.com/doc/ /"> <ModifyLoadBalancerAttributesResult> <LoadBalancerName>my-test-loadbalancer</LoadBalancerName> <LoadBalancerAttributes> <AccessLog> <Enabled>true</Enabled> <S3BucketName>my-loadbalancer-logs</S3BucketName> <S3BucketPrefix>my-bucket-prefix/prod</S3BucketPrefix> <EmitInterval>60</EmitInterval> </AccessLog> </LoadBalancerAttributes> </ModifyLoadBalancerAttributesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ModifyLoadBalancerAttributesResponse> Enable Connection Draining Sample Request &LoadBalancerAttributes.ConnectionDraining.Enabled=true &LoadBalancerAttributes.ConnectionDraining.Timeout=60 &Version= &Action=ModifyLoadBalancerAttributes &AUTHPARAMS Sample Response <<ModifyLoadBalancerAttributesResponse xmlns=" aws.com/doc/ /"> <ModifyLoadBalancerAttributesResult> <LoadBalancerName>my-test-loadbalancer</LoadBalancerName> <LoadBalancerAttributes> <ConnectionDraining> <Enabled>true</Enabled> <Timeout>60</Timeout> </ConnectionDraining> </LoadBalancerAttributes> </ModifyLoadBalancerAttributesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> 56

65 </ModifyLoadBalancerAttributesResponse> Configure Connection Settings Sample Request &LoadBalancerAttributes.ConnectionSettings.IdleTimeout=30 &Version= &Action=ModifyLoadBalancerAttributes &AUTHPARAMS Sample Response <<ModifyLoadBalancerAttributesResponse xmlns=" aws.com/doc/ /"> <ModifyLoadBalancerAttributesResult> <LoadBalancerName>my-test-loadbalancer</LoadBalancerName> <LoadBalancerAttributes> <ConnectionSettings> <IdleTimeout>30</IdleTimeout> </ConnectionSettings> </LoadBalancerAttributes> </ModifyLoadBalancerAttributesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ModifyLoadBalancerAttributesResponse> 57

66 RegisterInstancesWithLoadBalancer RegisterInstancesWithLoadBalancer Adds new instances to the load balancer. Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer. When an instance registered with a load balancer is stopped and then restarted, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use Deregister- InstancesFromLoadBalancer (p. 29) action. For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide. Note In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer. Note Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly. You can use DescribeLoadBalancers (p. 43) or DescribeInstanceHealth (p. 31) action to check the state of the newly registered instances. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Instances.member.N A list of instance IDs that should be registered with the load balancer. Type: Instance (p. 79) list LoadBalancerName The name associated with the load balancer. The name must be unique within your set of load balancers. Response Elements The following element is returned in a structure named RegisterInstancesWithLoadBalancerResult. Instances An updated list of instances for the load balancer. 58

67 Errors Type: Instance (p. 79) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidEndPoint The specified EndPoint is not valid. Sample Request 315b7e51 &LoadBalancerName=my-test-loadbalancer &Version= &Action=RegisterInstancesWithLoadBalancer &AUTHPARAMS Sample Response <RegisterInstancesWithLoadBalancerResponse xmlns=" cing.amazonaws.com/doc/ /"> <RegisterInstancesWithLoadBalancerResult> <Instances> <member> <InstanceId>i-315b7e51</InstanceId> </member> </Instances> </RegisterInstancesWithLoadBalancerResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </RegisterInstancesWithLoadBalancerResponse> 59

68 RemoveTags RemoveTags Removes one or more tags from the specified load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerNames.member.N The name of the load balancer. You can specify a maximum of one load balancer name. list Tags.member.N A list of tag keys to remove. Type: TagKeyOnly (p. 92) list Length constraints: Minimum of 1 item(s) in the list. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. Remove Two Tag Keys from the Load Balancer Sample Request &Tags.member.1.Key=department &Tags.member.2.Key=project &Action=RemoveTags &Version= &AUTHPARAMS 60

69 Sample Response <RemoveTagsResponse xmlns=" <RemoveTagsResult/> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </RemoveTagsResponse> 61

70 SetLoadBalancerListenerSSLCertificate SetLoadBalancerListenerSSLCertificate Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name of the load balancer. LoadBalancerPort The port that uses the specified SSL certificate. Type: Integer SSLCertificateId The Amazon Resource Number (ARN) of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS Identity and Access Management User Guide. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 ListenerNotFound Load balancer does not have a listener configured at the given port. 62

71 Sample Request ancer &SSLCertificateId=arn:aws:iam:: :server-certificate/testcert &LoadBalancerPort=443 &Version= &Action=SetLoadBalancerListenerSSLCertificate &AUTHPARAMS Sample Response <SetLoadBalancerListenerSSLCertificateResponse xmlns=" cing.amazonaws.com/doc/ /"> <SetLoadBalancerListenerSSLCertificateResult/> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </SetLoadBalancerListenerSSLCertificateResponse> 63

72 SetLoadBalancerPoliciesForBackendServer SetLoadBalancerPoliciesForBackendServer Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy (p. 24), they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies. Note The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable. You can use DescribeLoadBalancers (p. 43) or DescribeLoadBalancerPolicies (p. 37) action to verify that the policy has been associated with the back-end server. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). InstancePort The port number associated with the back-end server. Type: Integer LoadBalancerName The mnemonic name associated with the load balancer. This name must be unique within the set of your load balancers. PolicyNames.member.N List of policy names to be set. If the list is empty, then all current polices are removed from the backend server. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code:

73 PolicyNotFound One or more specified policies were not found. Sample Request &PolicyNames.member.1=EnableProxyProtocol &PolicyNames.member.2=MyPolicyName2 &PolicyNames.member.3=MyPolicyName3 &LoadBalancerName=my-test-loadbalancer &Version= &Action=SetLoadBalancerPoliciesForBackendServer &AUTHPARAMS Sample Response <SetLoadBalancerPoliciesForBackendServerResponse xmlns=" ancing.amazonaws.com/doc/ /"> <SetLoadBalancerPoliciesForBackendServerResult/> <ResponseMetadata> <RequestId>0eb9b381-dde0-11e2-8d78-6ddbaEXAMPLE</RequestId> </ResponseMetadata> </SetLoadBalancerPoliciesForBackendServerResponse> 65

74 SetLoadBalancerPoliciesOfListener SetLoadBalancerPoliciesOfListener Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name of the load balancer. LoadBalancerPort The external port of the load balancer to associate the policy. Type: Integer PolicyNames.member.N List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 ListenerNotFound Load balancer does not have a listener configured at the given port. PolicyNotFound One or more specified policies were not found. 66

75 Sample Request ationpolicy &LoadBalancerName=MyInternalLoadBalancer &LoadBalancerPort=443 &Version= &Action=SetLoadBalancerPoliciesOfListener &AUTHPARAMS Sample Response <SetLoadBalancerPoliciesOfListenerResponse xmlns=" azonaws.com/doc/ /"> <SetLoadBalancerPoliciesOfListenerResult/> <ResponseMetadata> <RequestId>07b1ecbc e3-acaf-dd7edEXAMPLE</RequestId> </ResponseMetadata> </SetLoadBalancerPoliciesOfListenerResponse> 67

76 Data Types The Elastic Load Balancing API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in the response is not guaranteed. Applications should not assume a particular order. The following data types are supported: AccessLog (p. 69) AddTagsResult (p. 70) AppCookieStickinessPolicy (p. 70) ApplySecurityGroupsToLoadBalancerResult (p. 71) AttachLoadBalancerToSubnetsResult (p. 71) BackendServer (p. 71) ConfigureHealthCheckResult (p. 72) ConnectionDraining (p. 72) ConnectionSettings (p. 72) CreateAppCookieStickinessPolicyResult (p. 73) CreateLBCookieStickinessPolicyResult (p. 73) CreateLoadBalancerListenersResult (p. 73) CreateLoadBalancerPolicyResult (p. 73) CreateLoadBalancerResult (p. 74) CrossZoneLoadBalancing (p. 74) DeleteLoadBalancerListenersResult (p. 74) DeleteLoadBalancerPolicyResult (p. 75) DeleteLoadBalancerResult (p. 75) DeregisterInstancesFromLoadBalancerResult (p. 75) DescribeInstanceHealthResult (p. 75) DescribeLoadBalancerAttributesResult (p. 76) DescribeLoadBalancerPoliciesResult (p. 76) DescribeLoadBalancerPolicyTypesResult (p. 76) DescribeLoadBalancersResult (p. 77) 68

77 AccessLog DescribeTagsResult (p. 77) DetachLoadBalancerFromSubnetsResult (p. 77) DisableAvailabilityZonesForLoadBalancerResult (p. 78) EnableAvailabilityZonesForLoadBalancerResult (p. 78) HealthCheck (p. 78) Instance (p. 79) InstanceState (p. 80) LBCookieStickinessPolicy (p. 80) Listener (p. 81) Listener (p. 82) LoadBalancerAttributes (p. 82) LoadBalancer (p. 83) ModifyLoadBalancerAttributesResult (p. 85) Policies (p. 86) PolicyAttribute (p. 86) PolicyAttribute (p. 87) PolicyAttributeType (p. 87) Policy (p. 88) PolicyType (p. 89) RegisterInstancesWithLoadBalancerResult (p. 89) RemoveTagsResult (p. 89) SetLoadBalancerListenerSSLCertificateResult (p. 90) SetLoadBalancerPoliciesForBackendServerResult (p. 90) SetLoadBalancerPoliciesOfListenerResult (p. 90) SourceSecurityGroup (p. 90) Tag (p. 91) Tag (p. 91) TagKeyOnly (p. 92) AccessLog The AccessLog data type. EmitInterval The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes. Default: 60 minutes Type: Integer Enabled Specifies whether access log is enabled for the load balancer. 69

78 AddTagsResult Type: Boolean S3BucketName The name of the Amazon S3 bucket where the access logs are stored. S3BucketPrefix The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket. AddTagsResult The output for the AddTags (p. 3) action. AppCookieStickinessPolicy The AppCookieStickinessPolicy data type. CookieName The name of the application cookie used for stickiness. PolicyName The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. 70

79 ApplySecurityGroupsToLoadBalancerResult ApplySecurityGroupsToLoadBalancerResult The out for the ApplySecurityGroupsToLoadBalancer (p. 5) action. SecurityGroups A list of security group IDs associated with your load balancer. list AttachLoadBalancerToSubnetsResult The output for the AttachLoadBalancerToSubnets (p. 7) action. Subnets A list of subnet IDs attached to the load balancer. list BackendServer This data type is used as a response element in the DescribeLoadBalancers (p. 43) action to describe the configuration of the back-end server. InstancePort Provides the port on which the back-end server is listening. Type: Integer PolicyNames Provides a list of policy names enabled for the back-end server. list 71

80 ConfigureHealthCheckResult ConfigureHealthCheckResult The output for the ConfigureHealthCheck (p. 9) action. HealthCheck The updated healthcheck for the instances. Type: HealthCheck (p. 78) ConnectionDraining The ConnectionDraining data type. Enabled Specifies whether connection draining is enabled for the load balancer. Type: Boolean Timeout Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances. Type: Integer ConnectionSettings The ConnectionSettings data type. 72

81 IdleTimeout Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer. Type: Integer CreateAppCookieStickinessPolicyResult The output for the CreateAppCookieStickinessPolicy (p. 11) action. CreateLBCookieStickinessPolicyResult The output for the CreateLBCookieStickinessPolicy (p. 13) action. CreateLoadBalancerListenersResult The output for the CreateLoadBalancerListeners (p. 22) action. CreateLoadBalancerPolicyResult The output for the CreateLoadBalancerPolicy (p. 24) action. 73

82 CreateLoadBalancerResult The output for the CreateLoadBalancer (p. 15) action. DNSName The DNS name for the load balancer. CrossZoneLoadBalancing The CrossZoneLoadBalancing data type. Enabled Specifies whether cross-zone load balancing is enabled for the load balancer. Type: Boolean DeleteLoadBalancerListenersResult The output for the DeleteLoadBalancerListeners (p. 27) action. 74

83 DeleteLoadBalancerPolicyResult The output for the DeleteLoadBalancerPolicy (p. 28) action. DeleteLoadBalancerResult The output for the DeleteLoadBalancer (p. 26) action. DeregisterInstancesFromLoadBalancerResult The output for the DeregisterInstancesFromLoadBalancer (p. 29) action. Instances An updated list of remaining instances registered with the load balancer. Type: Instance (p. 79) list DescribeInstanceHealthResult The output for the DescribeInstanceHealth (p. 31) action. InstanceStates A list containing health information for the specified instances. 75

84 DescribeLoadBalancerAttributesResult Type: InstanceState (p. 80) list DescribeLoadBalancerAttributesResult The following element is returned in a structure named DescribeLoadBalancerAttributesResult. LoadBalancerAttributes The load balancer attributes structure. Type: LoadBalancerAttributes (p. 82) DescribeLoadBalancerPoliciesResult The output for the DescribeLoadBalancerPolicies (p. 37) action. Policys A list of policy description structures. Type: Policy (p. 88) list DescribeLoadBalancerPolicyTypesResult The output for the DescribeLoadBalancerPolicyTypes (p. 40) action. PolicyTypes List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. Type: PolicyType (p. 89) list 76

85 DescribeLoadBalancersResult DescribeLoadBalancersResult The output for the DescribeLoadBalancers (p. 43) action. LoadBalancers A list of load balancer description structures. Type: LoadBalancer (p. 83) list NextMarker Specifies the value of next marker if the request returned more than one page of results. DescribeTagsResult The output for the DescribeTags (p. 46) action. Tags A list of tag description structures. Type: Tag (p. 91) list DetachLoadBalancerFromSubnetsResult The output for the DetachLoadBalancerFromSubnets (p. 48) action. Subnets A list of subnet IDs the load balancer is now attached to. 77

86 DisableAvailabilityZonesForLoadBalancerResult list DisableAvailabilityZonesForLoadBalancerResult The output for the DisableAvailabilityZonesForLoadBalancer (p. 50) action. AvailabilityZones A list of updated Availability Zones for the load balancer. list EnableAvailabilityZonesForLoadBalancerResult The output for the EnableAvailabilityZonesForLoadBalancer (p. 52) action. AvailabilityZones An updated list of Availability Zones for the load balancer. list HealthCheck The HealthCheck data type. HealthyThreshold Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state. Type: Integer 78

87 Instance Interval Specifies the approximate interval, in seconds, between health checks of an individual instance. Type: Integer Target Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through Note TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. SSL is also specified as SSL: port pair, for example, SSL:5000. For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a grouping, for example "HT- TP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. The total length of the HTTP ping target needs to be bit Unicode characters or less. Timeout Specifies the amount of time, in seconds, during which no response means a failed health probe. Note This value must be less than the Interval value. Type: Integer UnhealthyThreshold Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state. Type: Integer Instance The Instance data type. 79

88 InstanceId Provides an EC2 instance ID. InstanceState The InstanceState data type. Provides a description of the instance state. InstanceId Provides an EC2 instance ID. ReasonCode Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the load balancer. Valid value: ELB Instance N/A State Specifies the current state of the instance. Valid value: InService OutOfService Unknown LBCookieStickinessPolicy The LBCookieStickinessPolicy data type. 80

89 CookieExpirationPeriod The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session. Type: Long PolicyName The name for the policy being created. The name must be unique within the set of policies for this load balancer. Listener The Listener data type. InstancePort Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the load balancer. Type: Integer InstanceProtocol Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. Note If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. Note If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP. LoadBalancerPort Specifies the external load balancer port number. This property cannot be modified for the life of the load balancer. Type: Integer 81

90 Listener Protocol Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer. SSLCertificateId The ARN string of the server certificate.to get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API. Listener The Listener data type. Listener The Listener data type. Type: Listener (p. 81) PolicyNames A list of policies enabled for this listener. An empty list indicates that no policies are enabled. list LoadBalancerAttributes The LoadBalancerAttributes data type. AccessLog The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify. For more information, see Enable Access Logs. Type: AccessLog (p. 69) 82

91 LoadBalancer ConnectionDraining The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance. For more information, see Enable Connection Draining. Type: ConnectionDraining (p. 72) ConnectionSettings The name of the load balancer attribute. By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration. For more information, see Configure Idle Connection Timeout. Type: ConnectionSettings (p. 72) CrossZoneLoadBalancing The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones. For more information, see Enable Cross-Zone Load Balancing. Type: CrossZoneLoadBalancing (p. 74) LoadBalancer Contains the result of a successful invocation of DescribeLoadBalancers (p. 43). AvailabilityZones Specifies a list of Availability Zones. list BackendServers Contains a list of back-end server descriptions. Type: BackendServer (p. 71) list 83

92 CanonicalHostedZoneName Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For information on how to associate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide. CanonicalHostedZoneNameID Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide. CreatedTime Provides the date and time the load balancer was created. Type: DateTime DNSName Specifies the external DNS name associated with the load balancer. HealthCheck Specifies information regarding the various health probes conducted on the load balancer. Type: HealthCheck (p. 78) Instances Provides a list of EC2 instance IDs for the load balancer. Type: Instance (p. 79) list Listeners LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the Listeners element. Type: Listener (p. 82) list LoadBalancerName Specifies the name associated with the load balancer. Policies Provides a list of policies defined for the load balancer. Type: Policies (p. 86) 84

93 ModifyLoadBalancerAttributesResult Scheme Specifies the type of load balancer. If the Scheme is internet-facing, the load balancer has a publicly resolvable DNS name that resolves to public IP addresses. If the Scheme is internal, the load balancer has a publicly resolvable DNS name that resolves to private IP addresses. This option is only available for load balancers attached to an Amazon VPC. SecurityGroups The security groups the load balancer is a member of (VPC only). list SourceSecurityGroup The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source. Type: SourceSecurityGroup (p. 90) Subnets Provides a list of VPC subnet IDs for the load balancer. list VPCId Provides the ID of the VPC attached to the load balancer. ModifyLoadBalancerAttributesResult The output for the ModifyLoadBalancerAttributes (p. 54) action. LoadBalancerAttributes The LoadBalancerAttributes data type. Type: LoadBalancerAttributes (p. 82) 85

94 Policies LoadBalancerName The name of the load balancer. Policies The policies data type. AppCookieStickinessPolicies A list of the AppCookieStickinessPolicy (p. 70) objects created with CreateAppCookieStickiness- Policy (p. 11). Type: AppCookieStickinessPolicy (p. 70) list LBCookieStickinessPolicies A list of LBCookieStickinessPolicy (p. 80) objects created with CreateAppCookieStickiness- Policy (p. 11). Type: LBCookieStickinessPolicy (p. 80) list OtherPolicies A list of policy names other than the stickiness policies. list PolicyAttribute The PolicyAttribute (p. 86) data type. This data type contains a key/value pair that defines properties of a specific policy. AttributeName The name of the attribute associated with the policy. 86

95 PolicyAttribute AttributeValue The value of the attribute associated with the policy. PolicyAttribute The PolicyAttribute data type. This data type is used to describe the attributes and values associated with a policy. AttributeName The name of the attribute associated with the policy. AttributeValue The value of the attribute associated with the policy. PolicyAttributeType The PolicyAttributeType data type. This data type is used to describe values that are acceptable for the policy attribute. AttributeName The name of the attribute associated with the policy type. AttributeType The type of attribute. For example, Boolean, Integer, etc. Cardinality The cardinality of the attribute. Valid Values: 87

96 Policy ONE(1) : Single value required ZERO_OR_ONE(0..1) : Up to one value can be supplied ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed ONE_OR_MORE(1..*0) : Required. Multiple values are allowed DefaultValue The default value of the attribute, if applicable. A human-readable description of the attribute. Policy The Policy data type. PolicyAttributes A list of policy attribute description structures. Type: PolicyAttribute (p. 87) list PolicyName The name of the policy associated with the load balancer. PolicyTypeName The name of the policy type associated with the load balancer. 88

97 PolicyType PolicyType The PolicyType (p. 89) data type. A human-readable description of the policy type. PolicyAttributeTypes The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service. Type: PolicyAttributeType (p. 87) list PolicyTypeName The name of the policy type. RegisterInstancesWithLoadBalancerResult The output for the RegisterInstancesWithLoadBalancer (p. 58) action. Instances An updated list of instances for the load balancer. Type: Instance (p. 79) list RemoveTagsResult The output for the RemoveTags (p. 60) action. 89

98 SetLoadBalancerListenerSSLCertificateResult The output for the SetLoadBalancerListenerSSLCertificate (p. 62) action. SetLoadBalancerPoliciesForBackendServerResult The output for the SetLoadBalancerPoliciesForBackendServer (p. 64) action. SetLoadBalancerPoliciesOfListenerResult The output for the SetLoadBalancerPoliciesOfListener (p. 66) action. SourceSecurityGroup This data type is used as a response element in the DescribeLoadBalancers (p. 43) action. For information about Elastic Load Balancing security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide. GroupName Name of the source security group. Use this value for the --source-group parameter of the ec2- authorize command in the Amazon EC2 command line tool. 90

99 Tag OwnerAlias Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the Amazon EC2 command line tool. Tag Metadata assigned to a load balancer consisting of key-value pair. For more information, see Tagging in the Elastic Load Balancing Developer Guide. Key The key of the tag. Length constraints: Minimum length of 1. Maximum length of 128. Value The value of the tag. Length constraints: Minimum length of 0. Maximum length of 256. Tag The descriptions of all the tags associated with load balancer. LoadBalancerName The name of the load balancer. 91

100 TagKeyOnly Tags List of tags associated with the load balancer. Type: Tag (p. 91) list Length constraints: Minimum of 1 item(s) in the list. TagKeyOnly The key of a tag to be removed. Key The name of the key. Length constraints: Minimum length of 1. Maximum length of

101 Common Parameters This section lists the request parameters that all actions use. Any action-specific parameters are listed in the topic for the action. Action The action to be performed. Default: None Type: string AuthParams The parameters that are required to authenticate a Conditional request. Contains: AWSAccessKeyID SignatureVersion Timestamp Signature Default: None Required: Conditional AWSAccessKeyId The access key ID that corresponds to the secret access key that you used to sign the request. Default: None Type: string Expires The date and time when the request signature expires, expressed in the format YYYY-MM- DDThh:mm:ssZ, as specified in the ISO 8601 standard. Condition: Requests must include either Timestamp or Expires, but not both. Default: None Type: string 93

102 Required: Conditional SecurityToken The temporary security token that was obtained through a call to AWS Security Token Service. For a list of services that support AWS Security Token Service, go to Using Temporary Security Credentials to Access AWS in Using Temporary Security Credentials. Default: None Type: string Signature The digital signature that you created for the request. For information about generating a signature, go to the service's developer documentation. Default: None Type: string SignatureMethod The hash algorithm that you used to create the request signature. Default: None Type: string Valid Values: HmacSHA256 HmacSHA1 SignatureVersion The signature version you use to sign the request. Set this to the value that is recommended for your service. Default: None Type: string Timestamp The date and time when the request was signed, expressed in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard. Condition: Requests must include either Timestamp or Expires, but not both. Default: None Type: string Required: Conditional Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Default: None Type: string 94

103 Common Parameters for Signature V4 Signing The following table lists the parameters that all actions use for signing Signature Version 4 requests. Any action-specific parameters are listed in the topic for that action. To view sample requests, see of Signed Signature Version 4 Requests or Signature Version 4 Test Suite in the Amazon Web Services General Reference. Action The action to be performed. Type: string Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/yyyymmdd/region/service/aws4_request. For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon Web Services General Reference. 95

104 Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMM- DD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Handling Dates in Signature Version 4 in the Amazon Web Services General Reference. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service. For a list of services that support AWS Security Token Service, go to Using Temporary Security Credentials to Access AWS in Using Temporary Security Credentials. Condition: If you're using temporary security credentials from the AWS Security Token Service, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-SignedHeaders Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Task 1: Create a Canonical Request For Signature Version 4 in the Amazon Web Services General Reference. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional 96

105 Common Errors This section lists the common errors that all actions return. Any action-specific errors are listed in the topic for the action. IncompleteSignature The request signature does not conform to AWS standards. InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 InvalidParameterCombination Parameters that must not be used together were used together. InvalidParameterValue An invalid or out-of-range value was supplied for the input parameter. InvalidQueryParameter The AWS query string is malformed or does not adhere to AWS standards. MalformedQueryString The query string contains a syntax error. HTTP Status Code: 404 MissingAction The request is missing an action or a required parameter. 97

106 MissingAuthenticationToken The request must contain either a valid (registered) AWS access key ID or X.509 certificate. HTTP Status Code: 403 MissingParameter A required parameter for the specified action is not supplied. OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 Throttling The request was denied due to request throttling. ValidationError The input fails to satisfy the constraints specified by an AWS service. 98