ElasticLoadBalancingv2 ¶

Table of Contents

ElasticLoadBalancingv2
- Client
- Paginators

Client ¶

class ElasticLoadBalancingv2.Client¶

A low-level client representing Elastic Load Balancing (Elastic Load Balancing v2):

client = session.create_client('elbv2')

These are the available methods:

add_tags(**kwargs)¶

Adds the specified tags to the specified resource. You can tag your Application Load Balancers and your target groups.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

To list the current tags for your resources, use DescribeTags . To remove tags from your resources, use RemoveTags .

See also: AWS API Documentation

Request Syntax

response = client.add_tags(
    ResourceArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

ResourceArns (list) –
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
- (string) –
Tags (list) –
[REQUIRED]

The tags. Each resource can have a maximum of 10 tags.
- (dict) –
  Information about a tag.
  - Key (string) – [REQUIRED]
    The key of the tag.
  - Value (string) –
    The value of the tag.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Returns:	`True` if the operation can be paginated, `False` otherwise.

create_listener(**kwargs)¶

Creates a listener for the specified Application Load Balancer.

You can create up to 10 listeners per load balancer.

To update a listener, use ModifyListener . When you are finished with a listener, you can delete it using DeleteListener . If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer .

For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_listener(
    LoadBalancerArn='string',
    Protocol='HTTP'|'HTTPS',
    Port=123,
    SslPolicy='string',
    Certificates=[
        {
            'CertificateArn': 'string'
        },
    ],
    DefaultActions=[
        {
            'Type': 'forward',
            'TargetGroupArn': 'string'
        },
    ]
)

Parameters:

LoadBalancerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.
Protocol (string) –
[REQUIRED]

The protocol for connections from clients to the load balancer.
Port (integer) –
[REQUIRED]

The port on which the load balancer is listening.
SslPolicy (string) – The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
Certificates (list) –
The SSL server certificate. You must provide exactly one certificate if the protocol is HTTPS.
- (dict) –
  Information about an SSL server certificate deployed on a load balancer.
  - CertificateArn (string) –
    The Amazon Resource Name (ARN) of the certificate.
DefaultActions (list) –
[REQUIRED]

The default action for the listener.
- (dict) –
  Information about an action.
  - Type (string) – [REQUIRED]
    The type of action.
  - TargetGroupArn (string) – [REQUIRED]
    The Amazon Resource Name (ARN) of the target group.

Return type:

dict

Returns:

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS',
            'Certificates': [
                {
                    'CertificateArn': 'string'
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- Listeners (list) –
  
  Information about the listener.
  - (dict) –
    
    Information about a listener.
    - ListenerArn (string) –
      
      The Amazon Resource Name (ARN) of the listener.
    - LoadBalancerArn (string) –
      
      The Amazon Resource Name (ARN) of the load balancer.
    - Port (integer) –
      
      The port on which the load balancer is listening.
    - Protocol (string) –
      
      The protocol for connections from clients to the load balancer.
    - Certificates (list) –
      
      The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
      - (dict) –
        
        Information about an SSL server certificate deployed on a load balancer.
        
        CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate.
    - SslPolicy (string) –
      
      The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
    - DefaultActions (list) –
      
      The default actions for the listener.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.

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': {
        '...': '...',
    },
}

create_load_balancer(**kwargs)¶

Creates an Application Load Balancer.

When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups , SetSubnets , SetIpAddressType , and AddTags .

To create listeners for your load balancer, use CreateListener . To describe your current load balancers, see DescribeLoadBalancers . When you are finished with a load balancer, you can delete it using DeleteLoadBalancer .

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide .

For more information, see Application Load Balancers in the Application Load Balancers Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_load_balancer(
    Name='string',
    Subnets=[
        'string',
    ],
    SecurityGroups=[
        'string',
    ],
    Scheme='internet-facing'|'internal',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IpAddressType='ipv4'|'dualstack'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
Subnets (list) –
[REQUIRED]

The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones.
- (string) –
SecurityGroups (list) –
The IDs of the security groups to assign to the load balancer.
- (string) –
Scheme (string) –
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.
Tags (list) –
One or more tags to assign to the load balancer.
- (dict) –
  Information about a tag.
  - Key (string) – [REQUIRED]
    The key of the tag.
  - Value (string) –
    The value of the tag.
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). Internal load balancers must use ipv4 .

Return type:

dict

Returns:

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'|'failed',
                'Reason': 'string'
            },
            'Type': 'application',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string'
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack'
        },
    ]
}

Response Structure

(dict) –
- LoadBalancers (list) –
  
  Information about the load balancer.
  - (dict) –
    
    Information about a load balancer.
    - LoadBalancerArn (string) –
      
      The Amazon Resource Name (ARN) of the load balancer.
    - DNSName (string) –
      
      The public DNS name of the load balancer.
    - CanonicalHostedZoneId (string) –
      
      The ID of the Amazon Route 53 hosted zone associated with the load balancer.
    - CreatedTime (datetime) –
      
      The date and time the load balancer was created.
    - LoadBalancerName (string) –
      
      The name of the load balancer.
    - Scheme (string) –
      
      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.
      
      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.
    - VpcId (string) –
      
      The ID of the VPC for the load balancer.
    - State (dict) –
      
      The state of the load balancer.
      - Code (string) –
        
        The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .
      - Reason (string) –
        
        A description of the state.
    - Type (string) –
      
      The type of load balancer.
    - AvailabilityZones (list) –
      
      The Availability Zones for the load balancer.
      - (dict) –
        
        Information about an Availability Zone.
        
        ZoneName (string) –
        
        The name of the Availability Zone.
        
        SubnetId (string) –
        
        The ID of the subnet.
    - SecurityGroups (list) –
      
      The IDs of the security groups for the load balancer.
      - (string) –
    - IpAddressType (string) –
      
      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

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': {
        '...': '...',
    },
}

create_rule(**kwargs)¶

Creates a rule for the specified listener.

Each rule can have one action and one condition. Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the default action for the default rule is taken. For more information, see Listener Rules in the Application Load Balancers Guide .

To view your current rules, use DescribeRules . To update a rule, use ModifyRule . To set the priorities of your rules, use SetRulePriorities . To delete a rule, use DeleteRule .

See also: AWS API Documentation

Request Syntax

response = client.create_rule(
    ListenerArn='string',
    Conditions=[
        {
            'Field': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Priority=123,
    Actions=[
        {
            'Type': 'forward',
            'TargetGroupArn': 'string'
        },
    ]
)

Parameters:

ListenerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the listener.
Conditions (list) –
[REQUIRED]

A condition. Each condition specifies a field name and a single value.

If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
- A-Z, a-z, 0-9
- - .
- - (matches 0 or more characters)
- ? (matches exactly 1 character)
If the field name is path-pattern , you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
- A-Z, a-z, 0-9
- _ - . $ / ~ ” ‘ @ : +
- (using amp;)
- - (matches 0 or more characters)
- ? (matches exactly 1 character)
- (dict) –
  Information about a condition for a rule.
  - Field (string) –
    The name of the field. The possible values are host-header and path-pattern .
  - Values (list) –
    The condition value.
    
    If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
    - A-Z, a-z, 0-9
    - - .
    - - (matches 0 or more characters)
    - ? (matches exactly 1 character)
    If the field name is path-pattern , you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
    - A-Z, a-z, 0-9
    - _ - . $ / ~ ” ‘ @ : +
    - (using amp;)
    - - (matches 0 or more characters)
    - ? (matches exactly 1 character)
    - (string) –
Priority (integer) –
[REQUIRED]

The priority for the rule. A listener can’t have multiple rules with the same priority.
Actions (list) –
[REQUIRED]

An action. Each action has the type forward and specifies a target group.
- (dict) –
  Information about an action.
  - Type (string) – [REQUIRED]
    The type of action.
  - TargetGroupArn (string) – [REQUIRED]
    The Amazon Resource Name (ARN) of the target group.

Return type:

dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'RuleArn': 'string',
            'Priority': 'string',
            'Conditions': [
                {
                    'Field': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'Actions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ],
            '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.
      - (dict) –
        
        Information about a condition for a rule.
        
        Field (string) –
        
        The name of the field. The possible values are host-header and path-pattern .
        
        Values (list) –
        
        The condition value.
        
        If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        .
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        If the field name is path-pattern , you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        _ - . $ / ~ ” ‘ @ : +
        
        (using amp;)
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        (string) –
    - Actions (list) –
      
      The actions.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.
    - IsDefault (boolean) –
      
      Indicates whether this is the default rule.

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': {
        '...': '...',
    },
}

create_target_group(**kwargs)¶

Creates a target group.

To register targets with the target group, use RegisterTargets . To update the health check settings for the target group, use ModifyTargetGroup . To monitor the health of targets in the target group, use DescribeTargetHealth .

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule .

To delete a target group, use DeleteTargetGroup .

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_target_group(
    Name='string',
    Protocol='HTTP'|'HTTPS',
    Port=123,
    VpcId='string',
    HealthCheckProtocol='HTTP'|'HTTPS',
    HealthCheckPort='string',
    HealthCheckPath='string',
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': 'string'
    }
)

Parameters:

Name (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.
Protocol (string) –
[REQUIRED]

The protocol to use for routing traffic to the targets.
Port (integer) –
[REQUIRED]

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.
VpcId (string) –
[REQUIRED]

The identifier of the virtual private cloud (VPC).
HealthCheckProtocol (string) – The protocol the load balancer uses when performing health checks on targets. The default is the HTTP protocol.
HealthCheckPort (string) – The port the load balancer uses when performing health checks on targets. The default is traffic-port , which indicates the port on which each target receives traffic from the load balancer.
HealthCheckPath (string) – The ping path that is the destination on the targets for health checks. The default is /.
HealthCheckIntervalSeconds (integer) – The approximate amount of time, in seconds, between health checks of an individual target. The default is 30 seconds.
HealthCheckTimeoutSeconds (integer) – The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.
HealthyThresholdCount (integer) – The number of consecutive health checks successes required before considering an unhealthy target healthy. The default is 5.
UnhealthyThresholdCount (integer) – The number of consecutive health check failures required before considering a target unhealthy. The default is 2.
Matcher (dict) –
The HTTP codes to use when checking for a successful response from a target. The default is 200.
- HttpCode (string) – [REQUIRED]
  The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

Return type:

dict

Returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS',
            'HealthCheckPort': 'string',
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string'
            },
            'LoadBalancerArns': [
                '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.
    - VpcId (string) –
      
      The ID of the VPC for the targets.
    - HealthCheckProtocol (string) –
      
      The protocol to use to connect with the target.
    - HealthCheckPort (string) –
      
      The port to use to connect with the target.
    - HealthCheckIntervalSeconds (integer) –
      
      The approximate amount of time, in seconds, between health checks of an individual target.
    - HealthCheckTimeoutSeconds (integer) –
      
      The amount of time, in seconds, during which no response means a failed health check.
    - HealthyThresholdCount (integer) –
      
      The number of consecutive health checks successes required before considering an unhealthy target healthy.
    - UnhealthyThresholdCount (integer) –
      
      The number of consecutive health check failures required before considering the target unhealthy.
    - HealthCheckPath (string) –
      
      The destination for the health check request.
    - Matcher (dict) –
      
      The HTTP codes to use when checking for a successful response from a target.
      - HttpCode (string) –
        
        The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
    - LoadBalancerArns (list) –
      
      The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
      - (string) –

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': {
        '...': '...',
    },
}

delete_listener(**kwargs)¶

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer .

See also: AWS API Documentation

Request Syntax

response = client.delete_listener(
    ListenerArn='string'
)

Parameters:

ListenerArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the listener.

Return type: dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

delete_load_balancer(**kwargs)¶

Deletes the specified Application Load Balancer and its attached listeners.

You can’t delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

See also: AWS API Documentation

Request Syntax

response = client.delete_load_balancer(
    LoadBalancerArn='string'
)

Parameters:

LoadBalancerArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.

Return type: dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

delete_rule(**kwargs)¶

Deletes the specified rule.

See also: AWS API Documentation

Request Syntax

response = client.delete_rule(
    RuleArn='string'
)

Parameters:

RuleArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the rule.

Return type: dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

delete_target_group(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_target_group(
    TargetGroupArn='string'
)

Parameters:

TargetGroupArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the target group.

Return type: dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

deregister_targets(**kwargs)¶

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
        },
    ]
)

Parameters:

TargetGroupArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the target group.
Targets (list) –
[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.
- (dict) –
  Information about a target.
  - Id (string) – [REQUIRED]
    The ID of the target.
  - Port (integer) –
    The port on which the target is listening.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

describe_account_limits(**kwargs)¶

Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see Limits for Your Application Load Balancer in the Application Load Balancer Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_account_limits(
    Marker='string',
    PageSize=123
)

Parameters:

Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

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 AWS account.
    - Name (string) –
      
      The name of the limit. The possible values are:
      - application-load-balancers
      - listeners-per-application-load-balancer
      - rules-per-application-load-balancer
      - target-groups
      - targets-per-application-load-balancer
    - Max (string) –
      
      The maximum value of the limit.
- NextMarker (string) –
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

describe_listeners(**kwargs)¶

Describes the specified listeners or the listeners for the specified Application 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
)

Parameters:

LoadBalancerArn (string) – The Amazon Resource Name (ARN) of the load balancer.
ListenerArns (list) –
The Amazon Resource Names (ARN) of the listeners.
- (string) –
Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS',
            'Certificates': [
                {
                    'CertificateArn': 'string'
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ]
        },
    ],
    'NextMarker': 'string'
}

Response Structure

(dict) –
- Listeners (list) –
  
  Information about the listeners.
  - (dict) –
    
    Information about a listener.
    - ListenerArn (string) –
      
      The Amazon Resource Name (ARN) of the listener.
    - LoadBalancerArn (string) –
      
      The Amazon Resource Name (ARN) of the load balancer.
    - Port (integer) –
      
      The port on which the load balancer is listening.
    - Protocol (string) –
      
      The protocol for connections from clients to the load balancer.
    - Certificates (list) –
      
      The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
      - (dict) –
        
        Information about an SSL server certificate deployed on a load balancer.
        
        CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate.
    - SslPolicy (string) –
      
      The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
    - DefaultActions (list) –
      
      The default actions for the listener.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.
- NextMarker (string) –
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

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': {
        '...': '...',
    },
}

describe_load_balancer_attributes(**kwargs)¶

Describes the attributes for the specified Application Load Balancer.

See also: AWS API Documentation

Request Syntax

response = client.describe_load_balancer_attributes(
    LoadBalancerArn='string'
)

Parameters:

LoadBalancerArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.

Return type: dict

Returns:

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.
      - access_logs.s3.enabled - Indicates whether access logs stored in Amazon S3 are enabled. The value is true or false .
      - access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.
      - access_logs.s3.prefix - The prefix for the location in the S3 bucket. If you don’t specify a prefix, the access logs are stored in the root of the bucket.
      - deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false .
      - idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.
    - Value (string) –
      The value of the attribute.

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': {
        '...': '...',
    },
}

describe_load_balancers(**kwargs)¶

Describes the specified Application Load Balancers or all of your Application Load Balancers.

To describe the listeners for a load balancer, use DescribeListeners . To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes .

See also: AWS API Documentation

Request Syntax

response = client.describe_load_balancers(
    LoadBalancerArns=[
        'string',
    ],
    Names=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

Parameters:

LoadBalancerArns (list) –
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
- (string) –
Names (list) –
The names of the load balancers.
- (string) –
Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

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'|'failed',
                'Reason': 'string'
            },
            'Type': 'application',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string'
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

(dict) –
- LoadBalancers (list) –
  
  Information about the load balancers.
  - (dict) –
    
    Information about a load balancer.
    - LoadBalancerArn (string) –
      
      The Amazon Resource Name (ARN) of the load balancer.
    - DNSName (string) –
      
      The public DNS name of the load balancer.
    - CanonicalHostedZoneId (string) –
      
      The ID of the Amazon Route 53 hosted zone associated with the load balancer.
    - CreatedTime (datetime) –
      
      The date and time the load balancer was created.
    - LoadBalancerName (string) –
      
      The name of the load balancer.
    - Scheme (string) –
      
      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.
      
      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.
    - VpcId (string) –
      
      The ID of the VPC for the load balancer.
    - State (dict) –
      
      The state of the load balancer.
      - Code (string) –
        
        The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .
      - Reason (string) –
        
        A description of the state.
    - Type (string) –
      
      The type of load balancer.
    - AvailabilityZones (list) –
      
      The Availability Zones for the load balancer.
      - (dict) –
        
        Information about an Availability Zone.
        
        ZoneName (string) –
        
        The name of the Availability Zone.
        
        SubnetId (string) –
        
        The ID of the subnet.
    - SecurityGroups (list) –
      
      The IDs of the security groups for the load balancer.
      - (string) –
    - IpAddressType (string) –
      
      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
- NextMarker (string) –
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

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': {
        '...': '...',
    },
}

describe_rules(**kwargs)¶

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
)

Parameters:

ListenerArn (string) – The Amazon Resource Name (ARN) of the listener.
RuleArns (list) –
The Amazon Resource Names (ARN) of the rules.
- (string) –
Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'RuleArn': 'string',
            'Priority': 'string',
            'Conditions': [
                {
                    'Field': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'Actions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ],
            '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.
      - (dict) –
        
        Information about a condition for a rule.
        
        Field (string) –
        
        The name of the field. The possible values are host-header and path-pattern .
        
        Values (list) –
        
        The condition value.
        
        If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        .
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        If the field name is path-pattern , you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        _ - . $ / ~ ” ‘ @ : +
        
        (using amp;)
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        (string) –
    - Actions (list) –
      
      The actions.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.
    - IsDefault (boolean) –
      
      Indicates whether this is the default rule.
- NextMarker (string) –
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

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': {
        '...': '...',
    },
}

describe_ssl_policies(**kwargs)¶

Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security Policies in the Application Load Balancers Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_ssl_policies(
    Names=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

Parameters:

Names (list) –
The names of the policies.
- (string) –
Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'SslPolicies': [
        {
            'SslProtocols': [
                'string',
            ],
            'Ciphers': [
                {
                    'Name': 'string',
                    'Priority': 123
                },
            ],
            'Name': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

(dict) –
- SslPolicies (list) –
  
  Information about the policies.
  - (dict) –
    
    Information about a policy used for SSL negotiation.
    - SslProtocols (list) –
      
      The protocols.
      - (string) –
    - 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) –
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

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': {
        '...': '...',
    },
}

describe_tags(**kwargs)¶

Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers and target groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_tags(
    ResourceArns=[
        'string',
    ]
)

Parameters:

ResourceArns (list) –

[REQUIRED]

The Amazon Resource Names (ARN) of the resources.

(string) –

Return type: dict

Returns:

Response Syntax

{
    'TagDescriptions': [
        {
            'ResourceArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- TagDescriptions (list) –
  Information about the tags.
  - (dict) –
    The tags associated with a resource.
    - ResourceArn (string) –
      The Amazon Resource Name (ARN) of the resource.
    - Tags (list) –
      Information about the tags.
      - (dict) –
        Information about a tag.
        
        Key (string) –
        The key of the tag.
        
        Value (string) –
        The value of the tag.

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': {
        '...': '...',
    },
}

describe_target_group_attributes(**kwargs)¶

Describes the attributes for the specified target group.

See also: AWS API Documentation

Request Syntax

response = client.describe_target_group_attributes(
    TargetGroupArn='string'
)

Parameters:

TargetGroupArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the target group.

Return type: dict

Returns:

Response Syntax

{
    'Attributes': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –
- Attributes (list) –
  Information about the target group attributes
  - (dict) –
    Information about a target group attribute.
    - Key (string) –
      The name of the attribute.
      - deregistration_delay.timeout_seconds - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused . The range is 0-3600 seconds. The default value is 300 seconds.
      - stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false .
      - stickiness.type - The type of sticky sessions. The possible value is lb_cookie .
      - stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
    - Value (string) –
      The value of the attribute.

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': {
        '...': '...',
    },
}

describe_target_groups(**kwargs)¶

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

To describe the targets for a target group, use DescribeTargetHealth . To describe the attributes of a target group, use DescribeTargetGroupAttributes .

See also: AWS API Documentation

Request Syntax

response = client.describe_target_groups(
    LoadBalancerArn='string',
    TargetGroupArns=[
        'string',
    ],
    Names=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

Parameters:

LoadBalancerArn (string) – The Amazon Resource Name (ARN) of the load balancer.
TargetGroupArns (list) –
The Amazon Resource Names (ARN) of the target groups.
- (string) –
Names (list) –
The names of the target groups.
- (string) –
Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS',
            'HealthCheckPort': 'string',
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string'
            },
            'LoadBalancerArns': [
                '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.
    - VpcId (string) –
      
      The ID of the VPC for the targets.
    - HealthCheckProtocol (string) –
      
      The protocol to use to connect with the target.
    - HealthCheckPort (string) –
      
      The port to use to connect with the target.
    - HealthCheckIntervalSeconds (integer) –
      
      The approximate amount of time, in seconds, between health checks of an individual target.
    - HealthCheckTimeoutSeconds (integer) –
      
      The amount of time, in seconds, during which no response means a failed health check.
    - HealthyThresholdCount (integer) –
      
      The number of consecutive health checks successes required before considering an unhealthy target healthy.
    - UnhealthyThresholdCount (integer) –
      
      The number of consecutive health check failures required before considering the target unhealthy.
    - HealthCheckPath (string) –
      
      The destination for the health check request.
    - Matcher (dict) –
      
      The HTTP codes to use when checking for a successful response from a target.
      - HttpCode (string) –
        
        The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
    - LoadBalancerArns (list) –
      
      The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
      - (string) –
- NextMarker (string) –
  
  The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

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': {
        '...': '...',
    },
}

describe_target_health(**kwargs)¶

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
        },
    ]
)

Parameters:

TargetGroupArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the target group.
Targets (list) –
The targets.
- (dict) –
  Information about a target.
  - Id (string) – [REQUIRED]
    The ID of the target.
  - Port (integer) –
    The port on which the target is listening.

Return type:

dict

Returns:

Response Syntax

{
    'TargetHealthDescriptions': [
        {
            'Target': {
                'Id': 'string',
                'Port': 123
            },
            'HealthCheckPort': 'string',
            'TargetHealth': {
                'State': 'initial'|'healthy'|'unhealthy'|'unused'|'draining',
                'Reason': 'Elb.RegistrationInProgress'|'Elb.InitialHealthChecking'|'Target.ResponseCodeMismatch'|'Target.Timeout'|'Target.FailedHealthChecks'|'Target.NotRegistered'|'Target.NotInUse'|'Target.DeregistrationInProgress'|'Target.InvalidState'|'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.
      - Port (integer) –
        
        The port on which the target is listening.
    - HealthCheckPort (string) –
      
      The port to use to connect with the target.
    - TargetHealth (dict) –
      
      The health information for the target.
      - State (string) –
        
        The state of the target.
      - Reason (string) –
        
        The reason code. If the target state is healthy , a reason code is not provided.
        
        If the target state is initial , the reason code can be one of the following values:
        
        Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.
        
        Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.
        
        If the target state is unhealthy , the reason code can be one of the following values:
        
        Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
        
        Target.Timeout - The health check requests timed out.
        
        Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.
        
        Elb.InternalError - The health checks failed due to an internal error.
        
        If the target state is unused , the reason code can be one of the following values:
        
        Target.NotRegistered - The target is not registered with the target group.
        
        Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
        
        Target.InvalidState - The target is in the stopped or terminated state.
        
        If the target state is draining , the reason code can be the following value:
        
        Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.
      - Description (string) –
        
        A description of the target health that provides additional details. If the state is healthy , a description is not provided.

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_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters:

ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to ClientMethod.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.

Returns:

The presigned url

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Raises:	OperationNotPageableError – Raised if the operation is not pageable. You can use the `client.can_paginate` method to check if an operation is pageable.
Return type:	L{botocore.paginate.Paginator}
Returns:	A paginator object.

get_waiter(waiter_name)¶

modify_listener(**kwargs)¶

Modifies the specified properties of the specified listener.

Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.

See also: AWS API Documentation

Request Syntax

response = client.modify_listener(
    ListenerArn='string',
    Port=123,
    Protocol='HTTP'|'HTTPS',
    SslPolicy='string',
    Certificates=[
        {
            'CertificateArn': 'string'
        },
    ],
    DefaultActions=[
        {
            'Type': 'forward',
            'TargetGroupArn': 'string'
        },
    ]
)

Parameters:

ListenerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the listener.
Port (integer) – The port for connections from clients to the load balancer.
Protocol (string) – The protocol for connections from clients to the load balancer.
SslPolicy (string) –
The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide .
Certificates (list) –
The SSL server certificate.
- (dict) –
  Information about an SSL server certificate deployed on a load balancer.
  - CertificateArn (string) –
    The Amazon Resource Name (ARN) of the certificate.
DefaultActions (list) –
The default actions.
- (dict) –
  Information about an action.
  - Type (string) – [REQUIRED]
    The type of action.
  - TargetGroupArn (string) – [REQUIRED]
    The Amazon Resource Name (ARN) of the target group.

Return type:

dict

Returns:

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS',
            'Certificates': [
                {
                    'CertificateArn': 'string'
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- Listeners (list) –
  
  Information about the modified listeners.
  - (dict) –
    
    Information about a listener.
    - ListenerArn (string) –
      
      The Amazon Resource Name (ARN) of the listener.
    - LoadBalancerArn (string) –
      
      The Amazon Resource Name (ARN) of the load balancer.
    - Port (integer) –
      
      The port on which the load balancer is listening.
    - Protocol (string) –
      
      The protocol for connections from clients to the load balancer.
    - Certificates (list) –
      
      The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
      - (dict) –
        
        Information about an SSL server certificate deployed on a load balancer.
        
        CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate.
    - SslPolicy (string) –
      
      The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
    - DefaultActions (list) –
      
      The default actions for the listener.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.

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': {
        '...': '...',
    },
}

modify_load_balancer_attributes(**kwargs)¶

Modifies the specified attributes of the specified Application 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'
        },
    ]
)

Parameters:

LoadBalancerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.
Attributes (list) –
[REQUIRED]

The load balancer attributes.
- (dict) –
  Information about a load balancer attribute.
  - Key (string) –
    The name of the attribute.
    - access_logs.s3.enabled - Indicates whether access logs stored in Amazon S3 are enabled. The value is true or false .
    - access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.
    - access_logs.s3.prefix - The prefix for the location in the S3 bucket. If you don’t specify a prefix, the access logs are stored in the root of the bucket.
    - deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false .
    - idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.
  - Value (string) –
    The value of the attribute.

Return type:

dict

Returns:

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.
      - access_logs.s3.enabled - Indicates whether access logs stored in Amazon S3 are enabled. The value is true or false .
      - access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.
      - access_logs.s3.prefix - The prefix for the location in the S3 bucket. If you don’t specify a prefix, the access logs are stored in the root of the bucket.
      - deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false .
      - idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.
    - Value (string) –
      
      The value of the attribute.

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': {
        '...': '...',
    },
}

modify_rule(**kwargs)¶

Modifies the specified rule.

Any existing properties that you do not modify retain their current values.

To modify the default action, use ModifyListener .

See also: AWS API Documentation

Request Syntax

response = client.modify_rule(
    RuleArn='string',
    Conditions=[
        {
            'Field': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Actions=[
        {
            'Type': 'forward',
            'TargetGroupArn': 'string'
        },
    ]
)

Parameters:

RuleArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the rule.
Conditions (list) –
The conditions.
- (dict) –
  Information about a condition for a rule.
  - Field (string) –
    The name of the field. The possible values are host-header and path-pattern .
  - Values (list) –
    The condition value.
    
    If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
    - A-Z, a-z, 0-9
    - - .
    - - (matches 0 or more characters)
    - ? (matches exactly 1 character)
    If the field name is path-pattern , you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
    - A-Z, a-z, 0-9
    - _ - . $ / ~ ” ‘ @ : +
    - (using amp;)
    - - (matches 0 or more characters)
    - ? (matches exactly 1 character)
    - (string) –
Actions (list) –
The actions.
- (dict) –
  Information about an action.
  - Type (string) – [REQUIRED]
    The type of action.
  - TargetGroupArn (string) – [REQUIRED]
    The Amazon Resource Name (ARN) of the target group.

Return type:

dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'RuleArn': 'string',
            'Priority': 'string',
            'Conditions': [
                {
                    'Field': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'Actions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ],
            '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.
      - (dict) –
        
        Information about a condition for a rule.
        
        Field (string) –
        
        The name of the field. The possible values are host-header and path-pattern .
        
        Values (list) –
        
        The condition value.
        
        If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        .
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        If the field name is path-pattern , you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        _ - . $ / ~ ” ‘ @ : +
        
        (using amp;)
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        (string) –
    - Actions (list) –
      
      The actions.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.
    - IsDefault (boolean) –
      
      Indicates whether this is the default rule.

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': {
        '...': '...',
    },
}

modify_target_group(**kwargs)¶

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

To monitor the health of the targets, use DescribeTargetHealth .

See also: AWS API Documentation

Request Syntax

response = client.modify_target_group(
    TargetGroupArn='string',
    HealthCheckProtocol='HTTP'|'HTTPS',
    HealthCheckPort='string',
    HealthCheckPath='string',
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': 'string'
    }
)

Parameters:

TargetGroupArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the target group.
HealthCheckProtocol (string) – The protocol to use to connect with the target.
HealthCheckPort (string) – The port to use to connect with the target.
HealthCheckPath (string) – The ping path that is the destination for the health check request.
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.
Matcher (dict) –
The HTTP codes to use when checking for a successful response from a target.
- HttpCode (string) – [REQUIRED]
  The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

Return type:

dict

Returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS',
            'HealthCheckPort': 'string',
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string'
            },
            'LoadBalancerArns': [
                '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.
    - VpcId (string) –
      
      The ID of the VPC for the targets.
    - HealthCheckProtocol (string) –
      
      The protocol to use to connect with the target.
    - HealthCheckPort (string) –
      
      The port to use to connect with the target.
    - HealthCheckIntervalSeconds (integer) –
      
      The approximate amount of time, in seconds, between health checks of an individual target.
    - HealthCheckTimeoutSeconds (integer) –
      
      The amount of time, in seconds, during which no response means a failed health check.
    - HealthyThresholdCount (integer) –
      
      The number of consecutive health checks successes required before considering an unhealthy target healthy.
    - UnhealthyThresholdCount (integer) –
      
      The number of consecutive health check failures required before considering the target unhealthy.
    - HealthCheckPath (string) –
      
      The destination for the health check request.
    - Matcher (dict) –
      
      The HTTP codes to use when checking for a successful response from a target.
      - HttpCode (string) –
        
        The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
    - LoadBalancerArns (list) –
      
      The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
      - (string) –

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': {
        '...': '...',
    },
}

modify_target_group_attributes(**kwargs)¶

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'
        },
    ]
)

Parameters:

TargetGroupArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the target group.
Attributes (list) –
[REQUIRED]

The attributes.
- (dict) –
  Information about a target group attribute.
  - Key (string) –
    The name of the attribute.
    - deregistration_delay.timeout_seconds - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused . The range is 0-3600 seconds. The default value is 300 seconds.
    - stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false .
    - stickiness.type - The type of sticky sessions. The possible value is lb_cookie .
    - stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
  - Value (string) –
    The value of the attribute.

Return type:

dict

Returns:

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.
      - deregistration_delay.timeout_seconds - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused . The range is 0-3600 seconds. The default value is 300 seconds.
      - stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false .
      - stickiness.type - The type of sticky sessions. The possible value is lb_cookie .
      - stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
    - Value (string) –
      
      The value of the attribute.

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': {
        '...': '...',
    },
}

register_targets(**kwargs)¶

Registers the specified targets with the specified target group.

By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.

The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is an EC2 instance, it must be in the running state when you register it.

To remove a target from a target group, use DeregisterTargets .

See also: AWS API Documentation

Request Syntax

response = client.register_targets(
    TargetGroupArn='string',
    Targets=[
        {
            'Id': 'string',
            'Port': 123
        },
    ]
)

Parameters:

TargetGroupArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the target group.
Targets (list) –
[REQUIRED]

The targets. The default port for a target is the port for the target group. You can specify a port override. If a target is already registered, you can register it again using a different port.
- (dict) –
  Information about a target.
  - Id (string) – [REQUIRED]
    The ID of the target.
  - Port (integer) –
    The port on which the target is listening.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

remove_tags(**kwargs)¶

Removes the specified tags from the specified resource.

To list the current tags for your resources, use DescribeTags .

See also: AWS API Documentation

Request Syntax

response = client.remove_tags(
    ResourceArns=[
        'string',
    ],
    TagKeys=[
        'string',
    ]
)

Parameters:

ResourceArns (list) –
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
- (string) –
TagKeys (list) –
[REQUIRED]

The tag keys for the tags to remove.
- (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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': {
        '...': '...',
    },
}

set_ip_address_type(**kwargs)¶

Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.

See also: AWS API Documentation

Request Syntax

response = client.set_ip_address_type(
    LoadBalancerArn='string',
    IpAddressType='ipv4'|'dualstack'
)

Parameters:

LoadBalancerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.
IpAddressType (string) –
[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 .

Return type:

dict

Returns:

Response Syntax

{
    'IpAddressType': 'ipv4'|'dualstack'
}

Response Structure

(dict) –
- IpAddressType (string) –
  
  The IP address type.

set_rule_priorities(**kwargs)¶

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
        },
    ]
)

Parameters:

RulePriorities (list) –

[REQUIRED]

The rule priorities.

(dict) –
Information about the priorities for the rules for a listener.
- RuleArn (string) –
  The Amazon Resource Name (ARN) of the rule.
- Priority (integer) –
  The rule priority.

Return type: dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'RuleArn': 'string',
            'Priority': 'string',
            'Conditions': [
                {
                    'Field': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'Actions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ],
            'IsDefault': True|False
        },
    ]
}

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.
      - (dict) –
        Information about a condition for a rule.
        
        Field (string) –
        The name of the field. The possible values are host-header and path-pattern .
        
        Values (list) –
        The condition value.
        
        If the field name is host-header , you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        .
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        If the field name is path-pattern , you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.
        
        A-Z, a-z, 0-9
        
        _ - . $ / ~ ” ‘ @ : +
        
        (using amp;)
        
        (matches 0 or more characters)
        
        ? (matches exactly 1 character)
        
        (string) –
    - Actions (list) –
      The actions.
      - (dict) –
        Information about an action.
        
        Type (string) –
        The type of action.
        
        TargetGroupArn (string) –
        The Amazon Resource Name (ARN) of the target group.
    - IsDefault (boolean) –
      Indicates whether this is the default rule.

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': {
        '...': '...',
    },
}

set_security_groups(**kwargs)¶

Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.

See also: AWS API Documentation

Request Syntax

response = client.set_security_groups(
    LoadBalancerArn='string',
    SecurityGroups=[
        'string',
    ]
)

Parameters:

LoadBalancerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.
SecurityGroups (list) –
[REQUIRED]

The IDs of the security groups.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SecurityGroupIds': [
        'string',
    ]
}

Response Structure

(dict) –
- SecurityGroupIds (list) –
  
  The IDs of the security groups associated with the load balancer.
  - (string) –

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': {
        '...': '...',
    },
}

set_subnets(**kwargs)¶

Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.

See also: AWS API Documentation

Request Syntax

response = client.set_subnets(
    LoadBalancerArn='string',
    Subnets=[
        'string',
    ]
)

Parameters:

LoadBalancerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the load balancer.
Subnets (list) –
[REQUIRED]

The IDs of the subnets. You must specify at least two subnets. You can add only one subnet per Availability Zone.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AvailabilityZones': [
        {
            'ZoneName': 'string',
            'SubnetId': 'string'
        },
    ]
}

Response Structure

(dict) –
- AvailabilityZones (list) –
  
  Information about the subnet and Availability Zone.
  - (dict) –
    
    Information about an Availability Zone.
    - ZoneName (string) –
      
      The name of the Availability Zone.
    - SubnetId (string) –
      
      The ID of the subnet.

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': {
        '...': '...',
    },
}

Paginators ¶

The available paginators are:

ElasticLoadBalancingv2.Paginator.DescribeListeners
ElasticLoadBalancingv2.Paginator.DescribeLoadBalancers
ElasticLoadBalancingv2.Paginator.DescribeTargetGroups

class ElasticLoadBalancingv2.Paginator.DescribeListeners¶

paginator = client.get_paginator('describe_listeners')

paginate(**kwargs)¶

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'
    }
)

Parameters:

LoadBalancerArn (string) – The Amazon Resource Name (ARN) of the load balancer.
ListenerArns (list) –
The Amazon Resource Names (ARN) of the listeners.
- (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  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.
- PageSize (integer) –
  The size of each page.
- StartingToken (string) –
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS',
            'Certificates': [
                {
                    'CertificateArn': 'string'
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': '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) –
      
      The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
      - (dict) –
        
        Information about an SSL server certificate deployed on a load balancer.
        
        CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate.
    - SslPolicy (string) –
      
      The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
    - DefaultActions (list) –
      
      The default actions for the listener.
      - (dict) –
        
        Information about an action.
        
        Type (string) –
        
        The type of action.
        
        TargetGroupArn (string) –
        
        The Amazon Resource Name (ARN) of the target group.
- NextToken (string) –
  
  A token to resume pagination.

class ElasticLoadBalancingv2.Paginator.DescribeLoadBalancers¶

paginator = client.get_paginator('describe_load_balancers')

paginate(**kwargs)¶

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'
    }
)

Parameters:

LoadBalancerArns (list) –
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
- (string) –
Names (list) –
The names of the load balancers.
- (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  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.
- PageSize (integer) –
  The size of each page.
- StartingToken (string) –
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

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'|'failed',
                'Reason': 'string'
            },
            'Type': 'application',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string'
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack'
        },
    ],
    '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 only route requests from clients with access to the VPC for the load balancer.
    - VpcId (string) –
      
      The ID of the VPC for the load balancer.
    - State (dict) –
      
      The state of the load balancer.
      - Code (string) –
        
        The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .
      - Reason (string) –
        
        A description of the state.
    - Type (string) –
      
      The type of load balancer.
    - AvailabilityZones (list) –
      
      The Availability Zones for the load balancer.
      - (dict) –
        
        Information about an Availability Zone.
        
        ZoneName (string) –
        
        The name of the Availability Zone.
        
        SubnetId (string) –
        
        The ID of the subnet.
    - SecurityGroups (list) –
      
      The IDs of the security groups for the load balancer.
      - (string) –
    - IpAddressType (string) –
      
      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
- NextToken (string) –
  
  A token to resume pagination.

class ElasticLoadBalancingv2.Paginator.DescribeTargetGroups¶

paginator = client.get_paginator('describe_target_groups')

paginate(**kwargs)¶

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'
    }
)

Parameters:

LoadBalancerArn (string) – The Amazon Resource Name (ARN) of the load balancer.
TargetGroupArns (list) –
The Amazon Resource Names (ARN) of the target groups.
- (string) –
Names (list) –
The names of the target groups.
- (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  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.
- PageSize (integer) –
  The size of each page.
- StartingToken (string) –
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS',
            'HealthCheckPort': 'string',
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string'
            },
            'LoadBalancerArns': [
                '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.
    - VpcId (string) –
      
      The ID of the VPC for the targets.
    - HealthCheckProtocol (string) –
      
      The protocol to use to connect with the target.
    - HealthCheckPort (string) –
      
      The port to use to connect with the target.
    - HealthCheckIntervalSeconds (integer) –
      
      The approximate amount of time, in seconds, between health checks of an individual target.
    - HealthCheckTimeoutSeconds (integer) –
      
      The amount of time, in seconds, during which no response means a failed health check.
    - HealthyThresholdCount (integer) –
      
      The number of consecutive health checks successes required before considering an unhealthy target healthy.
    - UnhealthyThresholdCount (integer) –
      
      The number of consecutive health check failures required before considering the target unhealthy.
    - HealthCheckPath (string) –
      
      The destination for the health check request.
    - Matcher (dict) –
      
      The HTTP codes to use when checking for a successful response from a target.
      - HttpCode (string) –
        
        The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).
    - LoadBalancerArns (list) –
      
      The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
      - (string) –
- NextToken (string) –
  
  A token to resume pagination.

Table Of Contents

Contents

ElasticLoadBalancingv2¶

Client¶

Paginators¶

ElasticLoadBalancingv2 ¶

Client ¶

Paginators ¶