Table of Contents
A low-level client representing Elastic Load Balancing (Elastic Load Balancing v2)
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:
For more information, see the Elastic Load Balancing User Guide .
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
import boto3
client = boto3.client('elbv2')
These are the available methods:
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
If the certificate in already in the certificate list, the call is successful but the certificate is not added again.
For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
response = client.add_listener_certificates(
ListenerArn='string',
Certificates=[
{
'CertificateArn': 'string',
'IsDefault': True|False
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
[REQUIRED]
The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault .
Information about an SSL server certificate.
The Amazon Resource Name (ARN) of the certificate.
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
dict
Response Syntax
{
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
]
}
Response Structure
(dict) --
Certificates (list) --
Information about the certificates in the certificate list.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
Exceptions
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.
See also: AWS API Documentation
Request Syntax
response = client.add_tags(
ResourceArns=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags.
Information about a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
Examples
This example adds the specified tags to the specified load balancer.
response = client.add_tags(
ResourceArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
],
Tags=[
{
'Key': 'project',
'Value': 'lima',
},
{
'Key': 'department',
'Value': 'digital-media',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Check if an operation can be paginated.
Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
See also: AWS API Documentation
Request Syntax
response = client.create_listener(
LoadBalancerArn='string',
Protocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
Port=123,
SslPolicy='string',
Certificates=[
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
DefaultActions=[
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
AlpnPolicy=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide .
[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault .
Information about an SSL server certificate.
The Amazon Resource Name (ARN) of the certificate.
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
[REQUIRED]
The actions for the default rule.
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
The type of action.
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The OAuth 2.0 client identifier.
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
The ID of the Amazon Cognito user pool client.
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
The port. You can specify a value from 1 to 65535 or #{port}.
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
The message.
The HTTP response code (2XX, 4XX, or 5XX).
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
One or more target groups. For Network Load Balancers, you can specify a single target group.
Information about how traffic will be distributed between multiple target groups in a forward rule.
The Amazon Resource Name (ARN) of the target group.
The weight. The range is 0 to 999.
The target group stickiness for the rule.
Indicates whether target group stickiness is enabled.
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
For more information, see ALPN policies in the Network Load Balancers Guide .
The tags to assign to the listener.
Information about a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'AlpnPolicy': [
'string',
]
},
]
}
Response Structure
(dict) --
Listeners (list) --
Information about the listener.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
[HTTPS or TLS listener] The default certificate for the listener.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
SslPolicy (string) --
[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
AlpnPolicy (list) --
[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
Exceptions
Examples
This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.
response = client.create_listener(
DefaultActions=[
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
Port=80,
Protocol='HTTP',
)
print(response)
Expected Output:
{
'Listeners': [
{
'DefaultActions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'ListenerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'Port': 80,
'Protocol': 'HTTP',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).
response = client.create_listener(
Certificates=[
{
'CertificateArn': 'arn:aws:iam::123456789012:server-certificate/my-server-cert',
},
],
DefaultActions=[
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
Port=443,
Protocol='HTTPS',
SslPolicy='ELBSecurityPolicy-2015-05',
)
print(response)
Expected Output:
{
'Listeners': [
{
'Certificates': [
{
'CertificateArn': 'arn:aws:iam::123456789012:server-certificate/my-server-cert',
},
],
'DefaultActions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'ListenerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'Port': 443,
'Protocol': 'HTTPS',
'SslPolicy': 'ELBSecurityPolicy-2015-05',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
See also: AWS API Documentation
Request Syntax
response = client.create_load_balancer(
Name='string',
Subnets=[
'string',
],
SubnetMappings=[
{
'SubnetId': 'string',
'AllocationId': 'string',
'PrivateIPv4Address': 'string',
'IPv6Address': 'string'
},
],
SecurityGroups=[
'string',
],
Scheme='internet-facing'|'internal',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Type='application'|'network'|'gateway',
IpAddressType='ipv4'|'dualstack',
CustomerOwnedIpv4Pool='string'
)
[REQUIRED]
The name of the load balancer.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
Information about a subnet mapping.
The ID of the subnet.
[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
[Network Load Balancers] The private IPv4 address for an internal load balancer.
[Network Load Balancers] The IPv6 address.
[Application Load Balancers] The IDs of the security groups for the load balancer.
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You cannot specify a scheme for a Gateway Load Balancer.
The tags to assign to the load balancer.
Information about a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'LoadBalancers': [
{
'LoadBalancerArn': 'string',
'DNSName': 'string',
'CanonicalHostedZoneId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LoadBalancerName': 'string',
'Scheme': 'internet-facing'|'internal',
'VpcId': 'string',
'State': {
'Code': 'active'|'provisioning'|'active_impaired'|'failed',
'Reason': 'string'
},
'Type': 'application'|'network'|'gateway',
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'OutpostId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string',
'PrivateIPv4Address': 'string',
'IPv6Address': 'string'
},
]
},
],
'SecurityGroups': [
'string',
],
'IpAddressType': 'ipv4'|'dualstack',
'CustomerOwnedIpv4Pool': 'string'
},
]
}
Response Structure
(dict) --
LoadBalancers (list) --
Information about the load balancer.
(dict) --
Information about a load balancer.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
DNSName (string) --
The public DNS name of the load balancer.
CanonicalHostedZoneId (string) --
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
CreatedTime (datetime) --
The date and time the load balancer was created.
LoadBalancerName (string) --
The name of the load balancer.
Scheme (string) --
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
VpcId (string) --
The ID of the VPC for the load balancer.
State (dict) --
The state of the load balancer.
Code (string) --
The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If load balancer is routing traffic but does not have the resources it needs to scale, its state is``active_impaired`` . If the load balancer could not be set up, its state is failed .
Reason (string) --
A description of the state.
Type (string) --
The type of load balancer.
AvailabilityZones (list) --
The subnets for the load balancer.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet. You can specify one subnet per Availability Zone.
OutpostId (string) --
[Application Load Balancers on Outposts] The ID of the Outpost.
LoadBalancerAddresses (list) --
[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
PrivateIPv4Address (string) --
[Network Load Balancers] The private IPv4 address for an internal load balancer.
IPv6Address (string) --
[Network Load Balancers] The IPv6 address.
SecurityGroups (list) --
The IDs of the security groups for the load balancer.
IpAddressType (string) --
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
CustomerOwnedIpv4Pool (string) --
[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
Exceptions
Examples
This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.
response = client.create_load_balancer(
Name='my-load-balancer',
Subnets=[
'subnet-b7d581c0',
'subnet-8360a9e7',
],
)
print(response)
Expected Output:
{
'LoadBalancers': [
{
'AvailabilityZones': [
{
'SubnetId': 'subnet-8360a9e7',
'ZoneName': 'us-west-2a',
},
{
'SubnetId': 'subnet-b7d581c0',
'ZoneName': 'us-west-2b',
},
],
'CanonicalHostedZoneId': 'Z2P70J7EXAMPLE',
'CreatedTime': datetime(2016, 3, 25, 21, 26, 12, 4, 85, 0),
'DNSName': 'my-load-balancer-424835706.us-west-2.elb.amazonaws.com',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'LoadBalancerName': 'my-load-balancer',
'Scheme': 'internet-facing',
'SecurityGroups': [
'sg-5943793c',
],
'State': {
'Code': 'provisioning',
},
'Type': 'application',
'VpcId': 'vpc-3ac0fb5f',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example creates an internal load balancer and enables the Availability Zones for the specified subnets.
response = client.create_load_balancer(
Name='my-internal-load-balancer',
Scheme='internal',
SecurityGroups=[
],
Subnets=[
'subnet-b7d581c0',
'subnet-8360a9e7',
],
)
print(response)
Expected Output:
{
'LoadBalancers': [
{
'AvailabilityZones': [
{
'SubnetId': 'subnet-8360a9e7',
'ZoneName': 'us-west-2a',
},
{
'SubnetId': 'subnet-b7d581c0',
'ZoneName': 'us-west-2b',
},
],
'CanonicalHostedZoneId': 'Z2P70J7EXAMPLE',
'CreatedTime': datetime(2016, 3, 25, 21, 29, 48, 4, 85, 0),
'DNSName': 'internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2',
'LoadBalancerName': 'my-internal-load-balancer',
'Scheme': 'internal',
'SecurityGroups': [
'sg-5943793c',
],
'State': {
'Code': 'provisioning',
},
'Type': 'application',
'VpcId': 'vpc-3ac0fb5f',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_rule(
ListenerArn='string',
Conditions=[
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
Priority=123,
Actions=[
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
[REQUIRED]
The conditions.
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
The field in the HTTP request. The following are the possible values:
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
Information for a host header condition. Specify only when Field is host-header .
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
Information for a path pattern condition. Specify only when Field is path-pattern .
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
Information for an HTTP header condition. Specify only when Field is http-header .
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
Information for a query string condition. Specify only when Field is query-string .
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
Information about a key/value pair.
The key. You can omit the key.
The value.
Information for an HTTP method condition. Specify only when Field is http-request-method .
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
Information for a source IP condition. Specify only when Field is source-ip .
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
[REQUIRED]
The rule priority. A listener can't have multiple rules with the same priority.
[REQUIRED]
The actions.
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
The type of action.
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The OAuth 2.0 client identifier.
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
The ID of the Amazon Cognito user pool client.
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
The port. You can specify a value from 1 to 65535 or #{port}.
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
The message.
The HTTP response code (2XX, 4XX, or 5XX).
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
One or more target groups. For Network Load Balancers, you can specify a single target group.
Information about how traffic will be distributed between multiple target groups in a forward rule.
The Amazon Resource Name (ARN) of the target group.
The weight. The range is 0 to 999.
The target group stickiness for the rule.
Indicates whether target group stickiness is enabled.
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
The tags to assign to the rule.
Information about a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'Rules': [
{
'RuleArn': 'string',
'Priority': 'string',
'Conditions': [
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
'Actions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'IsDefault': True|False
},
]
}
Response Structure
(dict) --
Rules (list) --
Information about the rule.
(dict) --
Information about a rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
Priority (string) --
The priority.
Conditions (list) --
The conditions. Each rule can include zero or one of the following conditions: http-request-method , host-header , path-pattern , and source-ip , and zero or more of the following conditions: http-header and query-string .
(dict) --
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
Field (string) --
The field in the HTTP request. The following are the possible values:
Values (list) --
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
HostHeaderConfig (dict) --
Information for a host header condition. Specify only when Field is host-header .
Values (list) --
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
PathPatternConfig (dict) --
Information for a path pattern condition. Specify only when Field is path-pattern .
Values (list) --
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
HttpHeaderConfig (dict) --
Information for an HTTP header condition. Specify only when Field is http-header .
HttpHeaderName (string) --
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
Values (list) --
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
QueryStringConfig (dict) --
Information for a query string condition. Specify only when Field is query-string .
Values (list) --
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
(dict) --
Information about a key/value pair.
Key (string) --
The key. You can omit the key.
Value (string) --
The value.
HttpRequestMethodConfig (dict) --
Information for an HTTP method condition. Specify only when Field is http-request-method .
Values (list) --
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
SourceIpConfig (dict) --
Information for a source IP condition. Specify only when Field is source-ip .
Values (list) --
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
Actions (list) --
The actions. Each rule must include exactly one of the following types of actions: forward , redirect , or fixed-response , and it must be the last action to be performed.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
IsDefault (boolean) --
Indicates whether this is the default rule.
Exceptions
Examples
This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).
response = client.create_rule(
Actions=[
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
Conditions=[
{
'Field': 'path-pattern',
'Values': [
'/img/*',
],
},
],
ListenerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
Priority=10,
)
print(response)
Expected Output:
{
'Rules': [
{
'Actions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'Conditions': [
{
'Field': 'path-pattern',
'Values': [
'/img/*',
],
},
],
'IsDefault': False,
'Priority': '10',
'RuleArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Creates a target group.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
See also: AWS API Documentation
Request Syntax
response = client.create_target_group(
Name='string',
Protocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
ProtocolVersion='string',
Port=123,
VpcId='string',
HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
HealthCheckPort='string',
HealthCheckEnabled=True|False,
HealthCheckPath='string',
HealthCheckIntervalSeconds=123,
HealthCheckTimeoutSeconds=123,
HealthyThresholdCount=123,
UnhealthyThresholdCount=123,
Matcher={
'HttpCode': 'string',
'GrpcCode': 'string'
},
TargetType='instance'|'ip'|'lambda',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the target group.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
[HTTP/HTTPS health checks] The destination for health checks on the targets.
[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
The tags to assign to the target group.
Information about a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'HealthCheckPort': 'string',
'HealthCheckEnabled': True|False,
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string',
'GrpcCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'|'lambda',
'ProtocolVersion': 'string'
},
]
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the target group.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening. Not used if the target is a Lambda function.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckEnabled (boolean) --
Indicates whether health checks are enabled.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for health checks on the targets.
Matcher (dict) --
The HTTP or gRPC codes to use when checking for a successful response from a target.
HttpCode (string) --
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
GrpcCode (string) --
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), or lambda (register a single Lambda function as a target).
ProtocolVersion (string) --
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC , HTTP1 , and HTTP2 .
Exceptions
Examples
This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.
response = client.create_target_group(
Name='my-targets',
Port=80,
Protocol='HTTP',
VpcId='vpc-3ac0fb5f',
)
print(response)
Expected Output:
{
'TargetGroups': [
{
'HealthCheckIntervalSeconds': 30,
'HealthCheckPath': '/',
'HealthCheckPort': 'traffic-port',
'HealthCheckProtocol': 'HTTP',
'HealthCheckTimeoutSeconds': 5,
'HealthyThresholdCount': 5,
'Matcher': {
'HttpCode': '200',
},
'Port': 80,
'Protocol': 'HTTP',
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'TargetGroupName': 'my-targets',
'UnhealthyThresholdCount': 2,
'VpcId': 'vpc-3ac0fb5f',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached.
See also: AWS API Documentation
Request Syntax
response = client.delete_listener(
ListenerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
{}
Response Structure
Exceptions
Examples
This example deletes the specified listener.
response = client.delete_listener(
ListenerArn='arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
See also: AWS API Documentation
Request Syntax
response = client.delete_load_balancer(
LoadBalancerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
{}
Response Structure
Exceptions
Examples
This example deletes the specified load balancer.
response = client.delete_load_balancer(
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified rule.
You can't delete the default rule.
See also: AWS API Documentation
Request Syntax
response = client.delete_rule(
RuleArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the rule.
{}
Response Structure
Exceptions
Examples
This example deletes the specified rule.
response = client.delete_rule(
RuleArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.
See also: AWS API Documentation
Request Syntax
response = client.delete_target_group(
TargetGroupArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
{}
Response Structure
Exceptions
Examples
This example deletes the specified target group.
response = client.delete_target_group(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
See also: AWS API Documentation
Request Syntax
response = client.deregister_targets(
TargetGroupArn='string',
Targets=[
{
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
[REQUIRED]
The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.
Information about a target.
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function.
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
An Availability Zone or all . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance .
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all .
If the target type is lambda , this parameter is optional and the only supported value is all .
dict
Response Syntax
{}
Response Structure
Exceptions
Examples
This example deregisters the specified instance from the specified target group.
response = client.deregister_targets(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
Targets=[
{
'Id': 'i-0f76fade',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
For more information, see the following:
See also: AWS API Documentation
Request Syntax
response = client.describe_account_limits(
Marker='string',
PageSize=123
)
dict
Response Syntax
{
'Limits': [
{
'Name': 'string',
'Max': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Limits (list) --
Information about the limits.
(dict) --
Information about an Elastic Load Balancing resource limit for your Amazon Web Services account.
Name (string) --
The name of the limit. The possible values are:
Max (string) --
The maximum value of the limit.
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).
For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_listener_certificates(
ListenerArn='string',
Marker='string',
PageSize=123
)
[REQUIRED]
The Amazon Resource Names (ARN) of the listener.
dict
Response Syntax
{
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Certificates (list) --
Information about the certificates.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Exceptions
Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.
See also: AWS API Documentation
Request Syntax
response = client.describe_listeners(
LoadBalancerArn='string',
ListenerArns=[
'string',
],
Marker='string',
PageSize=123
)
The Amazon Resource Names (ARN) of the listeners.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'AlpnPolicy': [
'string',
]
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Listeners (list) --
Information about the listeners.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
[HTTPS or TLS listener] The default certificate for the listener.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
SslPolicy (string) --
[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
AlpnPolicy (list) --
[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Exceptions
Examples
This example describes the specified listener.
response = client.describe_listeners(
ListenerArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
],
)
print(response)
Expected Output:
{
'Listeners': [
{
'DefaultActions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'ListenerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'Port': 80,
'Protocol': 'HTTP',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
See also: AWS API Documentation
Request Syntax
response = client.describe_load_balancer_attributes(
LoadBalancerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
{
'Attributes': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Information about the load balancer attributes.
Information about a load balancer attribute.
The name of the attribute.
The following attribute is supported by all load balancers:
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
The following attributes are supported by only Application Load Balancers:
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
The value of the attribute.
Exceptions
Examples
This example describes the attributes of the specified load balancer.
response = client.describe_load_balancer_attributes(
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
)
print(response)
Expected Output:
{
'Attributes': [
{
'Key': 'access_logs.s3.enabled',
'Value': 'false',
},
{
'Key': 'idle_timeout.timeout_seconds',
'Value': '60',
},
{
'Key': 'access_logs.s3.prefix',
'Value': '',
},
{
'Key': 'deletion_protection.enabled',
'Value': 'false',
},
{
'Key': 'access_logs.s3.bucket',
'Value': '',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified load balancers or all of your load balancers.
See also: AWS API Documentation
Request Syntax
response = client.describe_load_balancers(
LoadBalancerArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123
)
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
The names of the load balancers.
dict
Response Syntax
{
'LoadBalancers': [
{
'LoadBalancerArn': 'string',
'DNSName': 'string',
'CanonicalHostedZoneId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LoadBalancerName': 'string',
'Scheme': 'internet-facing'|'internal',
'VpcId': 'string',
'State': {
'Code': 'active'|'provisioning'|'active_impaired'|'failed',
'Reason': 'string'
},
'Type': 'application'|'network'|'gateway',
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'OutpostId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string',
'PrivateIPv4Address': 'string',
'IPv6Address': 'string'
},
]
},
],
'SecurityGroups': [
'string',
],
'IpAddressType': 'ipv4'|'dualstack',
'CustomerOwnedIpv4Pool': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
LoadBalancers (list) --
Information about the load balancers.
(dict) --
Information about a load balancer.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
DNSName (string) --
The public DNS name of the load balancer.
CanonicalHostedZoneId (string) --
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
CreatedTime (datetime) --
The date and time the load balancer was created.
LoadBalancerName (string) --
The name of the load balancer.
Scheme (string) --
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
VpcId (string) --
The ID of the VPC for the load balancer.
State (dict) --
The state of the load balancer.
Code (string) --
The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If load balancer is routing traffic but does not have the resources it needs to scale, its state is``active_impaired`` . If the load balancer could not be set up, its state is failed .
Reason (string) --
A description of the state.
Type (string) --
The type of load balancer.
AvailabilityZones (list) --
The subnets for the load balancer.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet. You can specify one subnet per Availability Zone.
OutpostId (string) --
[Application Load Balancers on Outposts] The ID of the Outpost.
LoadBalancerAddresses (list) --
[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
PrivateIPv4Address (string) --
[Network Load Balancers] The private IPv4 address for an internal load balancer.
IPv6Address (string) --
[Network Load Balancers] The IPv6 address.
SecurityGroups (list) --
The IDs of the security groups for the load balancer.
IpAddressType (string) --
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
CustomerOwnedIpv4Pool (string) --
[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Exceptions
Examples
This example describes the specified load balancer.
response = client.describe_load_balancers(
LoadBalancerArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
],
)
print(response)
Expected Output:
{
'LoadBalancers': [
{
'AvailabilityZones': [
{
'SubnetId': 'subnet-8360a9e7',
'ZoneName': 'us-west-2a',
},
{
'SubnetId': 'subnet-b7d581c0',
'ZoneName': 'us-west-2b',
},
],
'CanonicalHostedZoneId': 'Z2P70J7EXAMPLE',
'CreatedTime': datetime(2016, 3, 25, 21, 26, 12, 4, 85, 0),
'DNSName': 'my-load-balancer-424835706.us-west-2.elb.amazonaws.com',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'LoadBalancerName': 'my-load-balancer',
'Scheme': 'internet-facing',
'SecurityGroups': [
'sg-5943793c',
],
'State': {
'Code': 'active',
},
'Type': 'application',
'VpcId': 'vpc-3ac0fb5f',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_rules(
ListenerArn='string',
RuleArns=[
'string',
],
Marker='string',
PageSize=123
)
The Amazon Resource Names (ARN) of the rules.
dict
Response Syntax
{
'Rules': [
{
'RuleArn': 'string',
'Priority': 'string',
'Conditions': [
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
'Actions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'IsDefault': True|False
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Rules (list) --
Information about the rules.
(dict) --
Information about a rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
Priority (string) --
The priority.
Conditions (list) --
The conditions. Each rule can include zero or one of the following conditions: http-request-method , host-header , path-pattern , and source-ip , and zero or more of the following conditions: http-header and query-string .
(dict) --
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
Field (string) --
The field in the HTTP request. The following are the possible values:
Values (list) --
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
HostHeaderConfig (dict) --
Information for a host header condition. Specify only when Field is host-header .
Values (list) --
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
PathPatternConfig (dict) --
Information for a path pattern condition. Specify only when Field is path-pattern .
Values (list) --
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
HttpHeaderConfig (dict) --
Information for an HTTP header condition. Specify only when Field is http-header .
HttpHeaderName (string) --
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
Values (list) --
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
QueryStringConfig (dict) --
Information for a query string condition. Specify only when Field is query-string .
Values (list) --
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
(dict) --
Information about a key/value pair.
Key (string) --
The key. You can omit the key.
Value (string) --
The value.
HttpRequestMethodConfig (dict) --
Information for an HTTP method condition. Specify only when Field is http-request-method .
Values (list) --
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
SourceIpConfig (dict) --
Information for a source IP condition. Specify only when Field is source-ip .
Values (list) --
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
Actions (list) --
The actions. Each rule must include exactly one of the following types of actions: forward , redirect , or fixed-response , and it must be the last action to be performed.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
IsDefault (boolean) --
Indicates whether this is the default rule.
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Exceptions
Examples
This example describes the specified rule.
response = client.describe_rules(
RuleArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
],
)
print(response)
Expected Output:
{
'Rules': [
{
'Actions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'Conditions': [
{
'Field': 'path-pattern',
'Values': [
'/img/*',
],
},
],
'IsDefault': False,
'Priority': '10',
'RuleArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_ssl_policies(
Names=[
'string',
],
Marker='string',
PageSize=123
)
The names of the policies.
dict
Response Syntax
{
'SslPolicies': [
{
'SslProtocols': [
'string',
],
'Ciphers': [
{
'Name': 'string',
'Priority': 123
},
],
'Name': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
SslPolicies (list) --
Information about the security policies.
(dict) --
Information about a policy used for SSL negotiation.
SslProtocols (list) --
The protocols.
Ciphers (list) --
The ciphers.
(dict) --
Information about a cipher used in a policy.
Name (string) --
The name of the cipher.
Priority (integer) --
The priority of the cipher.
Name (string) --
The name of the policy.
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Exceptions
Examples
This example describes the specified policy used for SSL negotiation.
response = client.describe_ssl_policies(
Names=[
'ELBSecurityPolicy-2015-05',
],
)
print(response)
Expected Output:
{
'SslPolicies': [
{
'Ciphers': [
{
'Name': 'ECDHE-ECDSA-AES128-GCM-SHA256',
'Priority': 1,
},
{
'Name': 'ECDHE-RSA-AES128-GCM-SHA256',
'Priority': 2,
},
{
'Name': 'ECDHE-ECDSA-AES128-SHA256',
'Priority': 3,
},
{
'Name': 'ECDHE-RSA-AES128-SHA256',
'Priority': 4,
},
{
'Name': 'ECDHE-ECDSA-AES128-SHA',
'Priority': 5,
},
{
'Name': 'ECDHE-RSA-AES128-SHA',
'Priority': 6,
},
{
'Name': 'DHE-RSA-AES128-SHA',
'Priority': 7,
},
{
'Name': 'ECDHE-ECDSA-AES256-GCM-SHA384',
'Priority': 8,
},
{
'Name': 'ECDHE-RSA-AES256-GCM-SHA384',
'Priority': 9,
},
{
'Name': 'ECDHE-ECDSA-AES256-SHA384',
'Priority': 10,
},
{
'Name': 'ECDHE-RSA-AES256-SHA384',
'Priority': 11,
},
{
'Name': 'ECDHE-RSA-AES256-SHA',
'Priority': 12,
},
{
'Name': 'ECDHE-ECDSA-AES256-SHA',
'Priority': 13,
},
{
'Name': 'AES128-GCM-SHA256',
'Priority': 14,
},
{
'Name': 'AES128-SHA256',
'Priority': 15,
},
{
'Name': 'AES128-SHA',
'Priority': 16,
},
{
'Name': 'AES256-GCM-SHA384',
'Priority': 17,
},
{
'Name': 'AES256-SHA256',
'Priority': 18,
},
{
'Name': 'AES256-SHA',
'Priority': 19,
},
],
'Name': 'ELBSecurityPolicy-2015-05',
'SslProtocols': [
'TLSv1',
'TLSv1.1',
'TLSv1.2',
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
ResourceArns=[
'string',
]
)
[REQUIRED]
The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call.
{
'TagDescriptions': [
{
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
Information about the tags.
The tags associated with a resource.
The Amazon Resource Name (ARN) of the resource.
Information about the tags.
Information about a tag.
The key of the tag.
The value of the tag.
Exceptions
Examples
This example describes the tags assigned to the specified load balancer.
response = client.describe_tags(
ResourceArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
],
)
print(response)
Expected Output:
{
'TagDescriptions': [
{
'ResourceArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'Tags': [
{
'Key': 'project',
'Value': 'lima',
},
{
'Key': 'department',
'Value': 'digital-media',
},
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the attributes for the specified target group.
For more information, see the following:
See also: AWS API Documentation
Request Syntax
response = client.describe_target_group_attributes(
TargetGroupArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
{
'Attributes': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Information about the target group attributes
Information about a target group attribute.
The name of the attribute.
The following attribute is supported by all load balancers:
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
The following attributes are supported only by Network Load Balancers:
The value of the attribute.
Exceptions
Examples
This example describes the attributes of the specified target group.
response = client.describe_target_group_attributes(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
)
print(response)
Expected Output:
{
'Attributes': [
{
'Key': 'stickiness.enabled',
'Value': 'false',
},
{
'Key': 'deregistration_delay.timeout_seconds',
'Value': '300',
},
{
'Key': 'stickiness.type',
'Value': 'lb_cookie',
},
{
'Key': 'stickiness.lb_cookie.duration_seconds',
'Value': '86400',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
See also: AWS API Documentation
Request Syntax
response = client.describe_target_groups(
LoadBalancerArn='string',
TargetGroupArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123
)
The Amazon Resource Names (ARN) of the target groups.
The names of the target groups.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'HealthCheckPort': 'string',
'HealthCheckEnabled': True|False,
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string',
'GrpcCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'|'lambda',
'ProtocolVersion': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the target groups.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening. Not used if the target is a Lambda function.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckEnabled (boolean) --
Indicates whether health checks are enabled.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for health checks on the targets.
Matcher (dict) --
The HTTP or gRPC codes to use when checking for a successful response from a target.
HttpCode (string) --
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
GrpcCode (string) --
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), or lambda (register a single Lambda function as a target).
ProtocolVersion (string) --
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC , HTTP1 , and HTTP2 .
NextMarker (string) --
If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
Exceptions
Examples
This example describes the specified target group.
response = client.describe_target_groups(
TargetGroupArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
],
)
print(response)
Expected Output:
{
'TargetGroups': [
{
'HealthCheckIntervalSeconds': 30,
'HealthCheckPath': '/',
'HealthCheckPort': 'traffic-port',
'HealthCheckProtocol': 'HTTP',
'HealthCheckTimeoutSeconds': 5,
'HealthyThresholdCount': 5,
'LoadBalancerArns': [
'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
],
'Matcher': {
'HttpCode': '200',
},
'Port': 80,
'Protocol': 'HTTP',
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'TargetGroupName': 'my-targets',
'UnhealthyThresholdCount': 2,
'VpcId': 'vpc-3ac0fb5f',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the health of the specified targets or all of your targets.
See also: AWS API Documentation
Request Syntax
response = client.describe_target_health(
TargetGroupArn='string',
Targets=[
{
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
The targets.
Information about a target.
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function.
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
An Availability Zone or all . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance .
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all .
If the target type is lambda , this parameter is optional and the only supported value is all .
dict
Response Syntax
{
'TargetHealthDescriptions': [
{
'Target': {
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
'HealthCheckPort': 'string',
'TargetHealth': {
'State': 'initial'|'healthy'|'unhealthy'|'unused'|'draining'|'unavailable',
'Reason': 'Elb.RegistrationInProgress'|'Elb.InitialHealthChecking'|'Target.ResponseCodeMismatch'|'Target.Timeout'|'Target.FailedHealthChecks'|'Target.NotRegistered'|'Target.NotInUse'|'Target.DeregistrationInProgress'|'Target.InvalidState'|'Target.IpUnusable'|'Target.HealthCheckDisabled'|'Elb.InternalError',
'Description': 'string'
}
},
]
}
Response Structure
(dict) --
TargetHealthDescriptions (list) --
Information about the health of the targets.
(dict) --
Information about the health of a target.
Target (dict) --
The description of the target.
Id (string) --
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function.
Port (integer) --
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
AvailabilityZone (string) --
An Availability Zone or all . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance .
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all .
If the target type is lambda , this parameter is optional and the only supported value is all .
HealthCheckPort (string) --
The port to use to connect with the target.
TargetHealth (dict) --
The health information for the target.
State (string) --
The state of the target.
Reason (string) --
The reason code.
If the target state is healthy , a reason code is not provided.
If the target state is initial , the reason code can be one of the following values:
If the target state is unhealthy , the reason code can be one of the following values:
If the target state is unused , the reason code can be one of the following values:
If the target state is draining , the reason code can be the following value:
If the target state is unavailable , the reason code can be the following value:
Description (string) --
A description of the target health that provides additional details. If the state is healthy , a description is not provided.
Exceptions
Examples
This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.
response = client.describe_target_health(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
)
print(response)
Expected Output:
{
'TargetHealthDescriptions': [
{
'Target': {
'Id': 'i-0f76fade',
'Port': 80,
},
'TargetHealth': {
'Description': 'Given target group is not configured to receive traffic from ELB',
'Reason': 'Target.NotInUse',
'State': 'unused',
},
},
{
'HealthCheckPort': '80',
'Target': {
'Id': 'i-0f76fade',
'Port': 80,
},
'TargetHealth': {
'State': 'healthy',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes the health of the specified target. This target is healthy.
response = client.describe_target_health(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
Targets=[
{
'Id': 'i-0f76fade',
'Port': 80,
},
],
)
print(response)
Expected Output:
{
'TargetHealthDescriptions': [
{
'HealthCheckPort': '80',
'Target': {
'Id': 'i-0f76fade',
'Port': 80,
},
'TargetHealth': {
'State': 'healthy',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
See also: AWS API Documentation
Request Syntax
response = client.modify_listener(
ListenerArn='string',
Port=123,
Protocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
SslPolicy='string',
Certificates=[
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
DefaultActions=[
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
AlpnPolicy=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide .
[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault .
Information about an SSL server certificate.
The Amazon Resource Name (ARN) of the certificate.
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
The actions for the default rule.
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
The type of action.
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The OAuth 2.0 client identifier.
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
The ID of the Amazon Cognito user pool client.
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
The port. You can specify a value from 1 to 65535 or #{port}.
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
The message.
The HTTP response code (2XX, 4XX, or 5XX).
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
One or more target groups. For Network Load Balancers, you can specify a single target group.
Information about how traffic will be distributed between multiple target groups in a forward rule.
The Amazon Resource Name (ARN) of the target group.
The weight. The range is 0 to 999.
The target group stickiness for the rule.
Indicates whether target group stickiness is enabled.
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
For more information, see ALPN policies in the Network Load Balancers Guide .
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'AlpnPolicy': [
'string',
]
},
]
}
Response Structure
(dict) --
Listeners (list) --
Information about the modified listener.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
[HTTPS or TLS listener] The default certificate for the listener.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
SslPolicy (string) --
[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
AlpnPolicy (list) --
[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
Exceptions
Examples
This example changes the default action for the specified listener.
response = client.modify_listener(
DefaultActions=[
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f',
'Type': 'forward',
},
],
ListenerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
)
print(response)
Expected Output:
{
'Listeners': [
{
'DefaultActions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f',
'Type': 'forward',
},
],
'ListenerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'Port': 80,
'Protocol': 'HTTP',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example changes the server certificate for the specified HTTPS listener.
response = client.modify_listener(
Certificates=[
{
'CertificateArn': 'arn:aws:iam::123456789012:server-certificate/my-new-server-cert',
},
],
ListenerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65',
)
print(response)
Expected Output:
{
'Listeners': [
{
'Certificates': [
{
'CertificateArn': 'arn:aws:iam::123456789012:server-certificate/my-new-server-cert',
},
],
'DefaultActions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'ListenerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65',
'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
'Port': 443,
'Protocol': 'HTTPS',
'SslPolicy': 'ELBSecurityPolicy-2015-05',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
See also: AWS API Documentation
Request Syntax
response = client.modify_load_balancer_attributes(
LoadBalancerArn='string',
Attributes=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
[REQUIRED]
The load balancer attributes.
Information about a load balancer attribute.
The name of the attribute.
The following attribute is supported by all load balancers:
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
The following attributes are supported by only Application Load Balancers:
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
The value of the attribute.
dict
Response Syntax
{
'Attributes': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Attributes (list) --
Information about the load balancer attributes.
(dict) --
Information about a load balancer attribute.
Key (string) --
The name of the attribute.
The following attribute is supported by all load balancers:
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
The following attributes are supported by only Application Load Balancers:
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
Value (string) --
The value of the attribute.
Exceptions
Examples
This example enables deletion protection for the specified load balancer.
response = client.modify_load_balancer_attributes(
Attributes=[
{
'Key': 'deletion_protection.enabled',
'Value': 'true',
},
],
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
)
print(response)
Expected Output:
{
'Attributes': [
{
'Key': 'deletion_protection.enabled',
'Value': 'true',
},
{
'Key': 'access_logs.s3.enabled',
'Value': 'false',
},
{
'Key': 'idle_timeout.timeout_seconds',
'Value': '60',
},
{
'Key': 'access_logs.s3.prefix',
'Value': '',
},
{
'Key': 'access_logs.s3.bucket',
'Value': '',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example changes the idle timeout value for the specified load balancer.
response = client.modify_load_balancer_attributes(
Attributes=[
{
'Key': 'idle_timeout.timeout_seconds',
'Value': '30',
},
],
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
)
print(response)
Expected Output:
{
'Attributes': [
{
'Key': 'idle_timeout.timeout_seconds',
'Value': '30',
},
{
'Key': 'access_logs.s3.enabled',
'Value': 'false',
},
{
'Key': 'access_logs.s3.prefix',
'Value': '',
},
{
'Key': 'deletion_protection.enabled',
'Value': 'true',
},
{
'Key': 'access_logs.s3.bucket',
'Value': '',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.
response = client.modify_load_balancer_attributes(
Attributes=[
{
'Key': 'access_logs.s3.enabled',
'Value': 'true',
},
{
'Key': 'access_logs.s3.bucket',
'Value': 'my-loadbalancer-logs',
},
{
'Key': 'access_logs.s3.prefix',
'Value': 'myapp',
},
],
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
)
print(response)
Expected Output:
{
'Attributes': [
{
'Key': 'access_logs.s3.enabled',
'Value': 'true',
},
{
'Key': 'access_logs.s3.bucket',
'Value': 'my-load-balancer-logs',
},
{
'Key': 'access_logs.s3.prefix',
'Value': 'myapp',
},
{
'Key': 'idle_timeout.timeout_seconds',
'Value': '60',
},
{
'Key': 'deletion_protection.enabled',
'Value': 'false',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
See also: AWS API Documentation
Request Syntax
response = client.modify_rule(
RuleArn='string',
Conditions=[
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
Actions=[
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the rule.
The conditions.
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
The field in the HTTP request. The following are the possible values:
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
Information for a host header condition. Specify only when Field is host-header .
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
Information for a path pattern condition. Specify only when Field is path-pattern .
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
Information for an HTTP header condition. Specify only when Field is http-header .
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
Information for a query string condition. Specify only when Field is query-string .
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
Information about a key/value pair.
The key. You can omit the key.
The value.
Information for an HTTP method condition. Specify only when Field is http-request-method .
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
Information for a source IP condition. Specify only when Field is source-ip .
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
The actions.
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
The type of action.
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The OAuth 2.0 client identifier.
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
The ID of the Amazon Cognito user pool client.
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
The port. You can specify a value from 1 to 65535 or #{port}.
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
The message.
The HTTP response code (2XX, 4XX, or 5XX).
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
One or more target groups. For Network Load Balancers, you can specify a single target group.
Information about how traffic will be distributed between multiple target groups in a forward rule.
The Amazon Resource Name (ARN) of the target group.
The weight. The range is 0 to 999.
The target group stickiness for the rule.
Indicates whether target group stickiness is enabled.
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
dict
Response Syntax
{
'Rules': [
{
'RuleArn': 'string',
'Priority': 'string',
'Conditions': [
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
'Actions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'IsDefault': True|False
},
]
}
Response Structure
(dict) --
Rules (list) --
Information about the modified rule.
(dict) --
Information about a rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
Priority (string) --
The priority.
Conditions (list) --
The conditions. Each rule can include zero or one of the following conditions: http-request-method , host-header , path-pattern , and source-ip , and zero or more of the following conditions: http-header and query-string .
(dict) --
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
Field (string) --
The field in the HTTP request. The following are the possible values:
Values (list) --
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
HostHeaderConfig (dict) --
Information for a host header condition. Specify only when Field is host-header .
Values (list) --
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
PathPatternConfig (dict) --
Information for a path pattern condition. Specify only when Field is path-pattern .
Values (list) --
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
HttpHeaderConfig (dict) --
Information for an HTTP header condition. Specify only when Field is http-header .
HttpHeaderName (string) --
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
Values (list) --
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
QueryStringConfig (dict) --
Information for a query string condition. Specify only when Field is query-string .
Values (list) --
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
(dict) --
Information about a key/value pair.
Key (string) --
The key. You can omit the key.
Value (string) --
The value.
HttpRequestMethodConfig (dict) --
Information for an HTTP method condition. Specify only when Field is http-request-method .
Values (list) --
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
SourceIpConfig (dict) --
Information for a source IP condition. Specify only when Field is source-ip .
Values (list) --
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
Actions (list) --
The actions. Each rule must include exactly one of the following types of actions: forward , redirect , or fixed-response , and it must be the last action to be performed.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
IsDefault (boolean) --
Indicates whether this is the default rule.
Exceptions
Examples
This example modifies the condition for the specified rule.
response = client.modify_rule(
Conditions=[
{
'Field': 'path-pattern',
'Values': [
'/images/*',
],
},
],
RuleArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
)
print(response)
Expected Output:
{
'Rules': [
{
'Actions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'Conditions': [
{
'Field': 'path-pattern',
'Values': [
'/images/*',
],
},
],
'IsDefault': False,
'Priority': '10',
'RuleArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
See also: AWS API Documentation
Request Syntax
response = client.modify_target_group(
TargetGroupArn='string',
HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
HealthCheckPort='string',
HealthCheckPath='string',
HealthCheckEnabled=True|False,
HealthCheckIntervalSeconds=123,
HealthCheckTimeoutSeconds=123,
HealthyThresholdCount=123,
UnhealthyThresholdCount=123,
Matcher={
'HttpCode': 'string',
'GrpcCode': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
With Network Load Balancers, you can't modify this setting.
[HTTP/HTTPS health checks] The destination for health checks on the targets.
[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.
The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.
With Network Load Balancers, you can't modify this setting.
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
With Network Load Balancers, you can't modify this setting.
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
With Network Load Balancers, you can't modify this setting.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'HealthCheckPort': 'string',
'HealthCheckEnabled': True|False,
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string',
'GrpcCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'|'lambda',
'ProtocolVersion': 'string'
},
]
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the modified target group.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening. Not used if the target is a Lambda function.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckEnabled (boolean) --
Indicates whether health checks are enabled.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for health checks on the targets.
Matcher (dict) --
The HTTP or gRPC codes to use when checking for a successful response from a target.
HttpCode (string) --
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
GrpcCode (string) --
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), or lambda (register a single Lambda function as a target).
ProtocolVersion (string) --
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC , HTTP1 , and HTTP2 .
Exceptions
Examples
This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.
response = client.modify_target_group(
HealthCheckPort='443',
HealthCheckProtocol='HTTPS',
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f',
)
print(response)
Expected Output:
{
'TargetGroups': [
{
'HealthCheckIntervalSeconds': 30,
'HealthCheckPort': '443',
'HealthCheckProtocol': 'HTTPS',
'HealthCheckTimeoutSeconds': 5,
'HealthyThresholdCount': 5,
'LoadBalancerArns': [
'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
],
'Matcher': {
'HttpCode': '200',
},
'Port': 443,
'Protocol': 'HTTPS',
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f',
'TargetGroupName': 'my-https-targets',
'UnhealthyThresholdCount': 2,
'VpcId': 'vpc-3ac0fb5f',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified attributes of the specified target group.
See also: AWS API Documentation
Request Syntax
response = client.modify_target_group_attributes(
TargetGroupArn='string',
Attributes=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
[REQUIRED]
The attributes.
Information about a target group attribute.
The name of the attribute.
The following attribute is supported by all load balancers:
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
The following attributes are supported only by Network Load Balancers:
The value of the attribute.
dict
Response Syntax
{
'Attributes': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Attributes (list) --
Information about the attributes.
(dict) --
Information about a target group attribute.
Key (string) --
The name of the attribute.
The following attribute is supported by all load balancers:
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
The following attributes are supported only by Network Load Balancers:
Value (string) --
The value of the attribute.
Exceptions
Examples
This example sets the deregistration delay timeout to the specified value for the specified target group.
response = client.modify_target_group_attributes(
Attributes=[
{
'Key': 'deregistration_delay.timeout_seconds',
'Value': '600',
},
],
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
)
print(response)
Expected Output:
{
'Attributes': [
{
'Key': 'stickiness.enabled',
'Value': 'false',
},
{
'Key': 'deregistration_delay.timeout_seconds',
'Value': '600',
},
{
'Key': 'stickiness.type',
'Value': 'lb_cookie',
},
{
'Key': 'stickiness.lb_cookie.duration_seconds',
'Value': '86400',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Registers the specified targets with the specified target group.
If the target is an EC2 instance, it must be in the running state when you register it.
By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.
With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.
See also: AWS API Documentation
Request Syntax
response = client.register_targets(
TargetGroupArn='string',
Targets=[
{
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
[REQUIRED]
The targets.
Information about a target.
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function.
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
An Availability Zone or all . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance .
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all .
If the target type is lambda , this parameter is optional and the only supported value is all .
dict
Response Syntax
{}
Response Structure
Exceptions
Examples
This example registers the specified instances with the specified target group.
response = client.register_targets(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
Targets=[
{
'Id': 'i-80c8dd94',
},
{
'Id': 'i-ceddcd4d',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.
response = client.register_targets(
TargetGroupArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9',
Targets=[
{
'Id': 'i-80c8dd94',
'Port': 80,
},
{
'Id': 'i-80c8dd94',
'Port': 766,
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
See also: AWS API Documentation
Request Syntax
response = client.remove_listener_certificates(
ListenerArn='string',
Certificates=[
{
'CertificateArn': 'string',
'IsDefault': True|False
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the listener.
[REQUIRED]
The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault .
Information about an SSL server certificate.
The Amazon Resource Name (ARN) of the certificate.
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags(
ResourceArns=[
'string',
],
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys for the tags to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
Examples
This example removes the specified tags from the specified load balancer.
response = client.remove_tags(
ResourceArns=[
'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
],
TagKeys=[
'project',
'department',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.
See also: AWS API Documentation
Request Syntax
response = client.set_ip_address_type(
LoadBalancerArn='string',
IpAddressType='ipv4'|'dualstack'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
[REQUIRED]
The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4 . You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
dict
Response Syntax
{
'IpAddressType': 'ipv4'|'dualstack'
}
Response Structure
(dict) --
IpAddressType (string) --
The IP address type.
Exceptions
Sets the priorities of the specified rules.
You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
See also: AWS API Documentation
Request Syntax
response = client.set_rule_priorities(
RulePriorities=[
{
'RuleArn': 'string',
'Priority': 123
},
]
)
[REQUIRED]
The rule priorities.
Information about the priorities for the rules for a listener.
The Amazon Resource Name (ARN) of the rule.
The rule priority.
{
'Rules': [
{
'RuleArn': 'string',
'Priority': 'string',
'Conditions': [
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
'Actions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'IsDefault': True|False
},
]
}
Response Structure
Information about the rules.
Information about a rule.
The Amazon Resource Name (ARN) of the rule.
The priority.
The conditions. Each rule can include zero or one of the following conditions: http-request-method , host-header , path-pattern , and source-ip , and zero or more of the following conditions: http-header and query-string .
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
The field in the HTTP request. The following are the possible values:
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
Information for a host header condition. Specify only when Field is host-header .
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
Information for a path pattern condition. Specify only when Field is path-pattern .
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
Information for an HTTP header condition. Specify only when Field is http-header .
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
Information for a query string condition. Specify only when Field is query-string .
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
Information about a key/value pair.
The key. You can omit the key.
The value.
Information for an HTTP method condition. Specify only when Field is http-request-method .
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
Information for a source IP condition. Specify only when Field is source-ip .
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
The actions. Each rule must include exactly one of the following types of actions: forward , redirect , or fixed-response , and it must be the last action to be performed.
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
The type of action.
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The OAuth 2.0 client identifier.
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
The ID of the Amazon Cognito user pool client.
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
The behavior if the user is not authenticated. The following are possible values:
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
The port. You can specify a value from 1 to 65535 or #{port}.
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
The message.
The HTTP response code (2XX, 4XX, or 5XX).
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
One or more target groups. For Network Load Balancers, you can specify a single target group.
Information about how traffic will be distributed between multiple target groups in a forward rule.
The Amazon Resource Name (ARN) of the target group.
The weight. The range is 0 to 999.
The target group stickiness for the rule.
Indicates whether target group stickiness is enabled.
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
Indicates whether this is the default rule.
Exceptions
Examples
This example sets the priority of the specified rule.
response = client.set_rule_priorities(
RulePriorities=[
{
'Priority': 5,
'RuleArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3',
},
],
)
print(response)
Expected Output:
{
'Rules': [
{
'Actions': [
{
'TargetGroupArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
'Type': 'forward',
},
],
'Conditions': [
{
'Field': 'path-pattern',
'Values': [
'/img/*',
],
},
],
'IsDefault': False,
'Priority': '5',
'RuleArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.
You can't specify a security group for a Network Load Balancer or Gateway Load Balancer.
See also: AWS API Documentation
Request Syntax
response = client.set_security_groups(
LoadBalancerArn='string',
SecurityGroups=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
[REQUIRED]
The IDs of the security groups.
dict
Response Syntax
{
'SecurityGroupIds': [
'string',
]
}
Response Structure
(dict) --
SecurityGroupIds (list) --
The IDs of the security groups associated with the load balancer.
Exceptions
Examples
This example associates the specified security group with the specified load balancer.
response = client.set_security_groups(
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
SecurityGroups=[
'sg-5943793c',
],
)
print(response)
Expected Output:
{
'SecurityGroupIds': [
'sg-5943793c',
],
'ResponseMetadata': {
'...': '...',
},
}
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets.
When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.
See also: AWS API Documentation
Request Syntax
response = client.set_subnets(
LoadBalancerArn='string',
Subnets=[
'string',
],
SubnetMappings=[
{
'SubnetId': 'string',
'AllocationId': 'string',
'PrivateIPv4Address': 'string',
'IPv6Address': 'string'
},
],
IpAddressType='ipv4'|'dualstack'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the load balancer.
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
Information about a subnet mapping.
The ID of the subnet.
[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
[Network Load Balancers] The private IPv4 address for an internal load balancer.
[Network Load Balancers] The IPv6 address.
dict
Response Syntax
{
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'OutpostId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string',
'PrivateIPv4Address': 'string',
'IPv6Address': 'string'
},
]
},
],
'IpAddressType': 'ipv4'|'dualstack'
}
Response Structure
(dict) --
AvailabilityZones (list) --
Information about the subnets.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet. You can specify one subnet per Availability Zone.
OutpostId (string) --
[Application Load Balancers on Outposts] The ID of the Outpost.
LoadBalancerAddresses (list) --
[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
PrivateIPv4Address (string) --
[Network Load Balancers] The private IPv4 address for an internal load balancer.
IPv6Address (string) --
[Network Load Balancers] The IPv6 address.
IpAddressType (string) --
[Network Load Balancers] The IP address type.
Exceptions
Examples
This example enables the Availability Zones for the specified subnets for the specified load balancer.
response = client.set_subnets(
LoadBalancerArn='arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
Subnets=[
'subnet-8360a9e7',
'subnet-b7d581c0',
],
)
print(response)
Expected Output:
{
'AvailabilityZones': [
{
'SubnetId': 'subnet-8360a9e7',
'ZoneName': 'us-west-2a',
},
{
'SubnetId': 'subnet-b7d581c0',
'ZoneName': 'us-west-2b',
},
],
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
paginator = client.get_paginator('describe_account_limits')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_account_limits().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Limits': [
{
'Name': 'string',
'Max': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Information about the limits.
Information about an Elastic Load Balancing resource limit for your Amazon Web Services account.
The name of the limit. The possible values are:
The maximum value of the limit.
A token to resume pagination.
paginator = client.get_paginator('describe_listener_certificates')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_listener_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ListenerArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Names (ARN) of the listener.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Certificates (list) --
Information about the certificates.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_listeners')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_listeners().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LoadBalancerArn='string',
ListenerArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Names (ARN) of the listeners.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Listeners': [
{
'ListenerArn': 'string',
'LoadBalancerArn': 'string',
'Port': 123,
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Certificates': [
{
'CertificateArn': 'string',
'IsDefault': True|False
},
],
'SslPolicy': 'string',
'DefaultActions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'AlpnPolicy': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Listeners (list) --
Information about the listeners.
(dict) --
Information about a listener.
ListenerArn (string) --
The Amazon Resource Name (ARN) of the listener.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
Port (integer) --
The port on which the load balancer is listening.
Protocol (string) --
The protocol for connections from clients to the load balancer.
Certificates (list) --
[HTTPS or TLS listener] The default certificate for the listener.
(dict) --
Information about an SSL server certificate.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
IsDefault (boolean) --
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
SslPolicy (string) --
[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
DefaultActions (list) --
The default actions for the listener.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
AlpnPolicy (list) --
[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_load_balancers')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_load_balancers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LoadBalancerArns=[
'string',
],
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
The names of the load balancers.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LoadBalancers': [
{
'LoadBalancerArn': 'string',
'DNSName': 'string',
'CanonicalHostedZoneId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LoadBalancerName': 'string',
'Scheme': 'internet-facing'|'internal',
'VpcId': 'string',
'State': {
'Code': 'active'|'provisioning'|'active_impaired'|'failed',
'Reason': 'string'
},
'Type': 'application'|'network'|'gateway',
'AvailabilityZones': [
{
'ZoneName': 'string',
'SubnetId': 'string',
'OutpostId': 'string',
'LoadBalancerAddresses': [
{
'IpAddress': 'string',
'AllocationId': 'string',
'PrivateIPv4Address': 'string',
'IPv6Address': 'string'
},
]
},
],
'SecurityGroups': [
'string',
],
'IpAddressType': 'ipv4'|'dualstack',
'CustomerOwnedIpv4Pool': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LoadBalancers (list) --
Information about the load balancers.
(dict) --
Information about a load balancer.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
DNSName (string) --
The public DNS name of the load balancer.
CanonicalHostedZoneId (string) --
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
CreatedTime (datetime) --
The date and time the load balancer was created.
LoadBalancerName (string) --
The name of the load balancer.
Scheme (string) --
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
VpcId (string) --
The ID of the VPC for the load balancer.
State (dict) --
The state of the load balancer.
Code (string) --
The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If load balancer is routing traffic but does not have the resources it needs to scale, its state is``active_impaired`` . If the load balancer could not be set up, its state is failed .
Reason (string) --
A description of the state.
Type (string) --
The type of load balancer.
AvailabilityZones (list) --
The subnets for the load balancer.
(dict) --
Information about an Availability Zone.
ZoneName (string) --
The name of the Availability Zone.
SubnetId (string) --
The ID of the subnet. You can specify one subnet per Availability Zone.
OutpostId (string) --
[Application Load Balancers on Outposts] The ID of the Outpost.
LoadBalancerAddresses (list) --
[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
(dict) --
Information about a static IP address for a load balancer.
IpAddress (string) --
The static IP address.
AllocationId (string) --
[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
PrivateIPv4Address (string) --
[Network Load Balancers] The private IPv4 address for an internal load balancer.
IPv6Address (string) --
[Network Load Balancers] The IPv6 address.
SecurityGroups (list) --
The IDs of the security groups for the load balancer.
IpAddressType (string) --
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
CustomerOwnedIpv4Pool (string) --
[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_rules')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ListenerArn='string',
RuleArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Names (ARN) of the rules.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Rules': [
{
'RuleArn': 'string',
'Priority': 'string',
'Conditions': [
{
'Field': 'string',
'Values': [
'string',
],
'HostHeaderConfig': {
'Values': [
'string',
]
},
'PathPatternConfig': {
'Values': [
'string',
]
},
'HttpHeaderConfig': {
'HttpHeaderName': 'string',
'Values': [
'string',
]
},
'QueryStringConfig': {
'Values': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'HttpRequestMethodConfig': {
'Values': [
'string',
]
},
'SourceIpConfig': {
'Values': [
'string',
]
}
},
],
'Actions': [
{
'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
'TargetGroupArn': 'string',
'AuthenticateOidcConfig': {
'Issuer': 'string',
'AuthorizationEndpoint': 'string',
'TokenEndpoint': 'string',
'UserInfoEndpoint': 'string',
'ClientId': 'string',
'ClientSecret': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate',
'UseExistingClientSecret': True|False
},
'AuthenticateCognitoConfig': {
'UserPoolArn': 'string',
'UserPoolClientId': 'string',
'UserPoolDomain': 'string',
'SessionCookieName': 'string',
'Scope': 'string',
'SessionTimeout': 123,
'AuthenticationRequestExtraParams': {
'string': 'string'
},
'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
},
'Order': 123,
'RedirectConfig': {
'Protocol': 'string',
'Port': 'string',
'Host': 'string',
'Path': 'string',
'Query': 'string',
'StatusCode': 'HTTP_301'|'HTTP_302'
},
'FixedResponseConfig': {
'MessageBody': 'string',
'StatusCode': 'string',
'ContentType': 'string'
},
'ForwardConfig': {
'TargetGroups': [
{
'TargetGroupArn': 'string',
'Weight': 123
},
],
'TargetGroupStickinessConfig': {
'Enabled': True|False,
'DurationSeconds': 123
}
}
},
],
'IsDefault': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Rules (list) --
Information about the rules.
(dict) --
Information about a rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
Priority (string) --
The priority.
Conditions (list) --
The conditions. Each rule can include zero or one of the following conditions: http-request-method , host-header , path-pattern , and source-ip , and zero or more of the following conditions: http-header and query-string .
(dict) --
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method , host-header , path-pattern , and source-ip . Each rule can also optionally include one or more of each of the following conditions: http-header and query-string .
Field (string) --
The field in the HTTP request. The following are the possible values:
Values (list) --
The condition value. Specify only when Field is host-header or path-pattern . Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig .
If Field is host-header and you are not using HostHeaderConfig , you can specify a single host name (for example, my.example.com) in Values . A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
If Field is path-pattern and you are not using PathPatternConfig , you can specify a single path pattern (for example, /img/*) in Values . A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
HostHeaderConfig (dict) --
Information for a host header condition. Specify only when Field is host-header .
Values (list) --
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
PathPatternConfig (dict) --
Information for a path pattern condition. Specify only when Field is path-pattern .
Values (list) --
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig .
HttpHeaderConfig (dict) --
Information for an HTTP header condition. Specify only when Field is http-header .
HttpHeaderName (string) --
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
Values (list) --
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
QueryStringConfig (dict) --
Information for a query string condition. Specify only when Field is query-string .
Values (list) --
One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
(dict) --
Information about a key/value pair.
Key (string) --
The key. You can omit the key.
Value (string) --
The value.
HttpRequestMethodConfig (dict) --
Information for an HTTP method condition. Specify only when Field is http-request-method .
Values (list) --
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
SourceIpConfig (dict) --
Information for a source IP condition. Specify only when Field is source-ip .
Values (list) --
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig .
Actions (list) --
The actions. Each rule must include exactly one of the following types of actions: forward , redirect , or fixed-response , and it must be the last action to be performed.
(dict) --
Information about an action.
Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.
Type (string) --
The type of action.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
AuthenticateOidcConfig (dict) --
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc .
Issuer (string) --
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
AuthorizationEndpoint (string) --
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
TokenEndpoint (string) --
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint (string) --
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId (string) --
The OAuth 2.0 client identifier.
ClientSecret (string) --
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
UseExistingClientSecret (boolean) --
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
AuthenticateCognitoConfig (dict) --
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito .
UserPoolArn (string) --
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId (string) --
The ID of the Amazon Cognito user pool client.
UserPoolDomain (string) --
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
SessionCookieName (string) --
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Scope (string) --
The set of user claims to be requested from the IdP. The default is openid .
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionTimeout (integer) --
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
AuthenticationRequestExtraParams (dict) --
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest (string) --
The behavior if the user is not authenticated. The following are possible values:
Order (integer) --
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
RedirectConfig (dict) --
[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect .
Protocol (string) --
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
Port (string) --
The port. You can specify a value from 1 to 65535 or #{port}.
Host (string) --
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
Path (string) --
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
Query (string) --
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
StatusCode (string) --
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
FixedResponseConfig (dict) --
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response .
MessageBody (string) --
The message.
StatusCode (string) --
The HTTP response code (2XX, 4XX, or 5XX).
ContentType (string) --
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
ForwardConfig (dict) --
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .
TargetGroups (list) --
One or more target groups. For Network Load Balancers, you can specify a single target group.
(dict) --
Information about how traffic will be distributed between multiple target groups in a forward rule.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
Weight (integer) --
The weight. The range is 0 to 999.
TargetGroupStickinessConfig (dict) --
The target group stickiness for the rule.
Enabled (boolean) --
Indicates whether target group stickiness is enabled.
DurationSeconds (integer) --
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
IsDefault (boolean) --
Indicates whether this is the default rule.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_ssl_policies')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_ssl_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the policies.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SslPolicies': [
{
'SslProtocols': [
'string',
],
'Ciphers': [
{
'Name': 'string',
'Priority': 123
},
],
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SslPolicies (list) --
Information about the security policies.
(dict) --
Information about a policy used for SSL negotiation.
SslProtocols (list) --
The protocols.
Ciphers (list) --
The ciphers.
(dict) --
Information about a cipher used in a policy.
Name (string) --
The name of the cipher.
Priority (integer) --
The priority of the cipher.
Name (string) --
The name of the policy.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_target_groups')
Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_target_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LoadBalancerArn='string',
TargetGroupArns=[
'string',
],
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Names (ARN) of the target groups.
The names of the target groups.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TargetGroups': [
{
'TargetGroupArn': 'string',
'TargetGroupName': 'string',
'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'Port': 123,
'VpcId': 'string',
'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
'HealthCheckPort': 'string',
'HealthCheckEnabled': True|False,
'HealthCheckIntervalSeconds': 123,
'HealthCheckTimeoutSeconds': 123,
'HealthyThresholdCount': 123,
'UnhealthyThresholdCount': 123,
'HealthCheckPath': 'string',
'Matcher': {
'HttpCode': 'string',
'GrpcCode': 'string'
},
'LoadBalancerArns': [
'string',
],
'TargetType': 'instance'|'ip'|'lambda',
'ProtocolVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TargetGroups (list) --
Information about the target groups.
(dict) --
Information about a target group.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) of the target group.
TargetGroupName (string) --
The name of the target group.
Protocol (string) --
The protocol to use for routing traffic to the targets.
Port (integer) --
The port on which the targets are listening. Not used if the target is a Lambda function.
VpcId (string) --
The ID of the VPC for the targets.
HealthCheckProtocol (string) --
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
HealthCheckPort (string) --
The port to use to connect with the target.
HealthCheckEnabled (boolean) --
Indicates whether health checks are enabled.
HealthCheckIntervalSeconds (integer) --
The approximate amount of time, in seconds, between health checks of an individual target.
HealthCheckTimeoutSeconds (integer) --
The amount of time, in seconds, during which no response means a failed health check.
HealthyThresholdCount (integer) --
The number of consecutive health checks successes required before considering an unhealthy target healthy.
UnhealthyThresholdCount (integer) --
The number of consecutive health check failures required before considering the target unhealthy.
HealthCheckPath (string) --
The destination for health checks on the targets.
Matcher (dict) --
The HTTP or gRPC codes to use when checking for a successful response from a target.
HttpCode (string) --
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
GrpcCode (string) --
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
LoadBalancerArns (list) --
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
TargetType (string) --
The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), or lambda (register a single Lambda function as a target).
ProtocolVersion (string) --
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC , HTTP1 , and HTTP2 .
NextToken (string) --
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('load_balancer_available')
Polls ElasticLoadBalancingv2.Client.describe_load_balancers() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
LoadBalancerArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
The names of the load balancers.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('load_balancer_exists')
Polls ElasticLoadBalancingv2.Client.describe_load_balancers() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
LoadBalancerArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
The names of the load balancers.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('load_balancers_deleted')
Polls ElasticLoadBalancingv2.Client.describe_load_balancers() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
LoadBalancerArns=[
'string',
],
Names=[
'string',
],
Marker='string',
PageSize=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
The names of the load balancers.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('target_deregistered')
Polls ElasticLoadBalancingv2.Client.describe_target_health() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
TargetGroupArn='string',
Targets=[
{
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
The targets.
Information about a target.
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function.
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
An Availability Zone or all . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance .
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all .
If the target type is lambda , this parameter is optional and the only supported value is all .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('target_in_service')
Polls ElasticLoadBalancingv2.Client.describe_target_health() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
TargetGroupArn='string',
Targets=[
{
'Id': 'string',
'Port': 123,
'AvailabilityZone': 'string'
},
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the target group.
The targets.
Information about a target.
The ID of the target. If the target type of the target group is instance , specify an instance ID. If the target type is ip , specify an IP address. If the target type is lambda , specify the ARN of the Lambda function.
The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
An Availability Zone or all . This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance .
If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all .
If the target type is lambda , this parameter is optional and the only supported value is all .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None