ElasticLoadBalancingv2Client

Index > ElasticLoadBalancingv2 > ElasticLoadBalancingv2Client

Auto-generated documentation for ElasticLoadBalancingv2 type annotations stubs module mypy-boto3-elbv2.

ElasticLoadBalancingv2Client

Type annotations and code completion for boto3.client("elbv2"). boto3 documentation

# ElasticLoadBalancingv2Client usage example

from boto3.session import Session
from mypy_boto3_elbv2.client import ElasticLoadBalancingv2Client

def get_elbv2_client() -> ElasticLoadBalancingv2Client:
    return Session().client("elbv2")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("elbv2").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("elbv2")

try:
    do_something(client)
except (
    client.exceptions.ALPNPolicyNotSupportedException,
    client.exceptions.AllocationIdNotFoundException,
    client.exceptions.AvailabilityZoneNotSupportedException,
    client.exceptions.CaCertificatesBundleNotFoundException,
    client.exceptions.CapacityDecreaseRequestsLimitExceededException,
    client.exceptions.CapacityReservationPendingException,
    client.exceptions.CapacityUnitsLimitExceededException,
    client.exceptions.CertificateNotFoundException,
    client.exceptions.ClientError,
    client.exceptions.DeleteAssociationSameAccountException,
    client.exceptions.DuplicateListenerException,
    client.exceptions.DuplicateLoadBalancerNameException,
    client.exceptions.DuplicateTagKeysException,
    client.exceptions.DuplicateTargetGroupNameException,
    client.exceptions.DuplicateTrustStoreNameException,
    client.exceptions.HealthUnavailableException,
    client.exceptions.IncompatibleProtocolsException,
    client.exceptions.InsufficientCapacityException,
    client.exceptions.InvalidCaCertificatesBundleException,
    client.exceptions.InvalidConfigurationRequestException,
    client.exceptions.InvalidLoadBalancerActionException,
    client.exceptions.InvalidRevocationContentException,
    client.exceptions.InvalidSchemeException,
    client.exceptions.InvalidSecurityGroupException,
    client.exceptions.InvalidSubnetException,
    client.exceptions.InvalidTargetException,
    client.exceptions.ListenerNotFoundException,
    client.exceptions.LoadBalancerNotFoundException,
    client.exceptions.OperationNotPermittedException,
    client.exceptions.PriorRequestNotCompleteException,
    client.exceptions.PriorityInUseException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.RevocationContentNotFoundException,
    client.exceptions.RevocationIdNotFoundException,
    client.exceptions.RuleNotFoundException,
    client.exceptions.SSLPolicyNotFoundException,
    client.exceptions.SubnetNotFoundException,
    client.exceptions.TargetGroupAssociationLimitException,
    client.exceptions.TargetGroupNotFoundException,
    client.exceptions.TooManyActionsException,
    client.exceptions.TooManyCertificatesException,
    client.exceptions.TooManyListenersException,
    client.exceptions.TooManyLoadBalancersException,
    client.exceptions.TooManyRegistrationsForTargetIdException,
    client.exceptions.TooManyRulesException,
    client.exceptions.TooManyTagsException,
    client.exceptions.TooManyTargetGroupsException,
    client.exceptions.TooManyTargetsException,
    client.exceptions.TooManyTrustStoreRevocationEntriesException,
    client.exceptions.TooManyTrustStoresException,
    client.exceptions.TooManyUniqueTargetGroupsPerLoadBalancerException,
    client.exceptions.TrustStoreAssociationNotFoundException,
    client.exceptions.TrustStoreInUseException,
    client.exceptions.TrustStoreNotFoundException,
    client.exceptions.TrustStoreNotReadyException,
    client.exceptions.UnsupportedProtocolException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_elbv2.client import Exceptions

def handle_error(exc: Exceptions.ALPNPolicyNotSupportedException) -> None:
    ...

Methods

add_listener_certificates

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

Type annotations and code completion for boto3.client("elbv2").add_listener_certificates method. boto3 documentation

# add_listener_certificates method definition

def add_listener_certificates(
    self,
    *,
    ListenerArn: str,
    Certificates: Sequence[CertificateTypeDef],  # (1)
) -> AddListenerCertificatesOutputTypeDef:  # (2)
    ...

1. See CertificateTypeDef
2. See AddListenerCertificatesOutputTypeDef

# add_listener_certificates method usage example with argument unpacking

kwargs: AddListenerCertificatesInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
    "Certificates": ...,
}

parent.add_listener_certificates(**kwargs)

1. See AddListenerCertificatesInputRequestTypeDef

add_tags

Adds the specified tags to the specified Elastic Load Balancing resource.

Type annotations and code completion for boto3.client("elbv2").add_tags method. boto3 documentation

# add_tags method definition

def add_tags(
    self,
    *,
    ResourceArns: Sequence[str],
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# add_tags method usage example with argument unpacking

kwargs: AddTagsInputRequestTypeDef = {  # (1)
    "ResourceArns": ...,
    "Tags": ...,
}

parent.add_tags(**kwargs)

1. See AddTagsInputRequestTypeDef

add_trust_store_revocations

Adds the specified revocation file to the specified trust store.

Type annotations and code completion for boto3.client("elbv2").add_trust_store_revocations method. boto3 documentation

# add_trust_store_revocations method definition

def add_trust_store_revocations(
    self,
    *,
    TrustStoreArn: str,
    RevocationContents: Sequence[RevocationContentTypeDef] = ...,  # (1)
) -> AddTrustStoreRevocationsOutputTypeDef:  # (2)
    ...

1. See RevocationContentTypeDef
2. See AddTrustStoreRevocationsOutputTypeDef

# add_trust_store_revocations method usage example with argument unpacking

kwargs: AddTrustStoreRevocationsInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
}

parent.add_trust_store_revocations(**kwargs)

1. See AddTrustStoreRevocationsInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("elbv2").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("elbv2").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_listener

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").create_listener method. boto3 documentation

# create_listener method definition

def create_listener(
    self,
    *,
    LoadBalancerArn: str,
    DefaultActions: Sequence[ActionUnionTypeDef],  # (1)
    Protocol: ProtocolEnumType = ...,  # (2)
    Port: int = ...,
    SslPolicy: str = ...,
    Certificates: Sequence[CertificateTypeDef] = ...,  # (3)
    AlpnPolicy: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    MutualAuthentication: MutualAuthenticationAttributesTypeDef = ...,  # (5)
) -> CreateListenerOutputTypeDef:  # (6)
    ...

1. See ActionTypeDef ActionOutputTypeDef
2. See ProtocolEnumType
3. See CertificateTypeDef
4. See TagTypeDef
5. See MutualAuthenticationAttributesTypeDef
6. See CreateListenerOutputTypeDef

# create_listener method usage example with argument unpacking

kwargs: CreateListenerInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
    "DefaultActions": ...,
}

parent.create_listener(**kwargs)

1. See CreateListenerInputRequestTypeDef

create_load_balancer

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").create_load_balancer method. boto3 documentation

# create_load_balancer method definition

def create_load_balancer(
    self,
    *,
    Name: str,
    Subnets: Sequence[str] = ...,
    SubnetMappings: Sequence[SubnetMappingTypeDef] = ...,  # (1)
    SecurityGroups: Sequence[str] = ...,
    Scheme: LoadBalancerSchemeEnumType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    Type: LoadBalancerTypeEnumType = ...,  # (4)
    IpAddressType: IpAddressTypeType = ...,  # (5)
    CustomerOwnedIpv4Pool: str = ...,
    EnablePrefixForIpv6SourceNat: EnablePrefixForIpv6SourceNatEnumType = ...,  # (6)
) -> CreateLoadBalancerOutputTypeDef:  # (7)
    ...

1. See SubnetMappingTypeDef
2. See LoadBalancerSchemeEnumType
3. See TagTypeDef
4. See LoadBalancerTypeEnumType
5. See IpAddressTypeType
6. See EnablePrefixForIpv6SourceNatEnumType
7. See CreateLoadBalancerOutputTypeDef

# create_load_balancer method usage example with argument unpacking

kwargs: CreateLoadBalancerInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_load_balancer(**kwargs)

1. See CreateLoadBalancerInputRequestTypeDef

create_rule

Creates a rule for the specified listener.

Type annotations and code completion for boto3.client("elbv2").create_rule method. boto3 documentation

# create_rule method definition

def create_rule(
    self,
    *,
    ListenerArn: str,
    Conditions: Sequence[RuleConditionUnionTypeDef],  # (1)
    Priority: int,
    Actions: Sequence[ActionTypeDef],  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateRuleOutputTypeDef:  # (4)
    ...

1. See RuleConditionTypeDef RuleConditionOutputTypeDef
2. See ActionTypeDef
3. See TagTypeDef
4. See CreateRuleOutputTypeDef

# create_rule method usage example with argument unpacking

kwargs: CreateRuleInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
    "Conditions": ...,
    "Priority": ...,
    "Actions": ...,
}

parent.create_rule(**kwargs)

1. See CreateRuleInputRequestTypeDef

create_target_group

Creates a target group.

Type annotations and code completion for boto3.client("elbv2").create_target_group method. boto3 documentation

# create_target_group method definition

def create_target_group(
    self,
    *,
    Name: str,
    Protocol: ProtocolEnumType = ...,  # (1)
    ProtocolVersion: str = ...,
    Port: int = ...,
    VpcId: str = ...,
    HealthCheckProtocol: ProtocolEnumType = ...,  # (1)
    HealthCheckPort: str = ...,
    HealthCheckEnabled: bool = ...,
    HealthCheckPath: str = ...,
    HealthCheckIntervalSeconds: int = ...,
    HealthCheckTimeoutSeconds: int = ...,
    HealthyThresholdCount: int = ...,
    UnhealthyThresholdCount: int = ...,
    Matcher: MatcherTypeDef = ...,  # (3)
    TargetType: TargetTypeEnumType = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    IpAddressType: TargetGroupIpAddressTypeEnumType = ...,  # (6)
) -> CreateTargetGroupOutputTypeDef:  # (7)
    ...

1. See ProtocolEnumType
2. See ProtocolEnumType
3. See MatcherTypeDef
4. See TargetTypeEnumType
5. See TagTypeDef
6. See TargetGroupIpAddressTypeEnumType
7. See CreateTargetGroupOutputTypeDef

# create_target_group method usage example with argument unpacking

kwargs: CreateTargetGroupInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_target_group(**kwargs)

1. See CreateTargetGroupInputRequestTypeDef

create_trust_store

Creates a trust store.

Type annotations and code completion for boto3.client("elbv2").create_trust_store method. boto3 documentation

# create_trust_store method definition

def create_trust_store(
    self,
    *,
    Name: str,
    CaCertificatesBundleS3Bucket: str,
    CaCertificatesBundleS3Key: str,
    CaCertificatesBundleS3ObjectVersion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTrustStoreOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateTrustStoreOutputTypeDef

# create_trust_store method usage example with argument unpacking

kwargs: CreateTrustStoreInputRequestTypeDef = {  # (1)
    "Name": ...,
    "CaCertificatesBundleS3Bucket": ...,
    "CaCertificatesBundleS3Key": ...,
}

parent.create_trust_store(**kwargs)

1. See CreateTrustStoreInputRequestTypeDef

delete_listener

Deletes the specified listener.

Type annotations and code completion for boto3.client("elbv2").delete_listener method. boto3 documentation

# delete_listener method definition

def delete_listener(
    self,
    *,
    ListenerArn: str,
) -> Dict[str, Any]:
    ...

# delete_listener method usage example with argument unpacking

kwargs: DeleteListenerInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
}

parent.delete_listener(**kwargs)

1. See DeleteListenerInputRequestTypeDef

delete_load_balancer

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").delete_load_balancer method. boto3 documentation

# delete_load_balancer method definition

def delete_load_balancer(
    self,
    *,
    LoadBalancerArn: str,
) -> Dict[str, Any]:
    ...

# delete_load_balancer method usage example with argument unpacking

kwargs: DeleteLoadBalancerInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.delete_load_balancer(**kwargs)

1. See DeleteLoadBalancerInputRequestTypeDef

delete_rule

Deletes the specified rule.

Type annotations and code completion for boto3.client("elbv2").delete_rule method. boto3 documentation

# delete_rule method definition

def delete_rule(
    self,
    *,
    RuleArn: str,
) -> Dict[str, Any]:
    ...

# delete_rule method usage example with argument unpacking

kwargs: DeleteRuleInputRequestTypeDef = {  # (1)
    "RuleArn": ...,
}

parent.delete_rule(**kwargs)

1. See DeleteRuleInputRequestTypeDef

delete_shared_trust_store_association

Deletes a shared trust store association.

Type annotations and code completion for boto3.client("elbv2").delete_shared_trust_store_association method. boto3 documentation

# delete_shared_trust_store_association method definition

def delete_shared_trust_store_association(
    self,
    *,
    TrustStoreArn: str,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...

# delete_shared_trust_store_association method usage example with argument unpacking

kwargs: DeleteSharedTrustStoreAssociationInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
    "ResourceArn": ...,
}

parent.delete_shared_trust_store_association(**kwargs)

1. See DeleteSharedTrustStoreAssociationInputRequestTypeDef

delete_target_group

Deletes the specified target group.

Type annotations and code completion for boto3.client("elbv2").delete_target_group method. boto3 documentation

# delete_target_group method definition

def delete_target_group(
    self,
    *,
    TargetGroupArn: str,
) -> Dict[str, Any]:
    ...

# delete_target_group method usage example with argument unpacking

kwargs: DeleteTargetGroupInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
}

parent.delete_target_group(**kwargs)

1. See DeleteTargetGroupInputRequestTypeDef

delete_trust_store

Deletes a trust store.

Type annotations and code completion for boto3.client("elbv2").delete_trust_store method. boto3 documentation

# delete_trust_store method definition

def delete_trust_store(
    self,
    *,
    TrustStoreArn: str,
) -> Dict[str, Any]:
    ...

# delete_trust_store method usage example with argument unpacking

kwargs: DeleteTrustStoreInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
}

parent.delete_trust_store(**kwargs)

1. See DeleteTrustStoreInputRequestTypeDef

deregister_targets

Deregisters the specified targets from the specified target group.

Type annotations and code completion for boto3.client("elbv2").deregister_targets method. boto3 documentation

# deregister_targets method definition

def deregister_targets(
    self,
    *,
    TargetGroupArn: str,
    Targets: Sequence[TargetDescriptionTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TargetDescriptionTypeDef

# deregister_targets method usage example with argument unpacking

kwargs: DeregisterTargetsInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
    "Targets": ...,
}

parent.deregister_targets(**kwargs)

1. See DeregisterTargetsInputRequestTypeDef

describe_account_limits

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.

Type annotations and code completion for boto3.client("elbv2").describe_account_limits method. boto3 documentation

# describe_account_limits method definition

def describe_account_limits(
    self,
    *,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeAccountLimitsOutputTypeDef:  # (1)
    ...

1. See DescribeAccountLimitsOutputTypeDef

# describe_account_limits method usage example with argument unpacking

kwargs: DescribeAccountLimitsInputRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.describe_account_limits(**kwargs)

1. See DescribeAccountLimitsInputRequestTypeDef

describe_capacity_reservation

Describes the capacity reservation status for the specified load balancer.

Type annotations and code completion for boto3.client("elbv2").describe_capacity_reservation method. boto3 documentation

# describe_capacity_reservation method definition

def describe_capacity_reservation(
    self,
    *,
    LoadBalancerArn: str,
) -> DescribeCapacityReservationOutputTypeDef:  # (1)
    ...

1. See DescribeCapacityReservationOutputTypeDef

# describe_capacity_reservation method usage example with argument unpacking

kwargs: DescribeCapacityReservationInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.describe_capacity_reservation(**kwargs)

1. See DescribeCapacityReservationInputRequestTypeDef

describe_listener_attributes

Describes the attributes for the specified listener.

Type annotations and code completion for boto3.client("elbv2").describe_listener_attributes method. boto3 documentation

# describe_listener_attributes method definition

def describe_listener_attributes(
    self,
    *,
    ListenerArn: str,
) -> DescribeListenerAttributesOutputTypeDef:  # (1)
    ...

1. See DescribeListenerAttributesOutputTypeDef

# describe_listener_attributes method usage example with argument unpacking

kwargs: DescribeListenerAttributesInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
}

parent.describe_listener_attributes(**kwargs)

1. See DescribeListenerAttributesInputRequestTypeDef

describe_listener_certificates

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

Type annotations and code completion for boto3.client("elbv2").describe_listener_certificates method. boto3 documentation

# describe_listener_certificates method definition

def describe_listener_certificates(
    self,
    *,
    ListenerArn: str,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeListenerCertificatesOutputTypeDef:  # (1)
    ...

1. See DescribeListenerCertificatesOutputTypeDef

# describe_listener_certificates method usage example with argument unpacking

kwargs: DescribeListenerCertificatesInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
}

parent.describe_listener_certificates(**kwargs)

1. See DescribeListenerCertificatesInputRequestTypeDef

describe_listeners

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").describe_listeners method. boto3 documentation

# describe_listeners method definition

def describe_listeners(
    self,
    *,
    LoadBalancerArn: str = ...,
    ListenerArns: Sequence[str] = ...,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeListenersOutputTypeDef:  # (1)
    ...

1. See DescribeListenersOutputTypeDef

# describe_listeners method usage example with argument unpacking

kwargs: DescribeListenersInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.describe_listeners(**kwargs)

1. See DescribeListenersInputRequestTypeDef

describe_load_balancer_attributes

Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").describe_load_balancer_attributes method. boto3 documentation

# describe_load_balancer_attributes method definition

def describe_load_balancer_attributes(
    self,
    *,
    LoadBalancerArn: str,
) -> DescribeLoadBalancerAttributesOutputTypeDef:  # (1)
    ...

1. See DescribeLoadBalancerAttributesOutputTypeDef

# describe_load_balancer_attributes method usage example with argument unpacking

kwargs: DescribeLoadBalancerAttributesInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.describe_load_balancer_attributes(**kwargs)

1. See DescribeLoadBalancerAttributesInputRequestTypeDef

describe_load_balancers

Describes the specified load balancers or all of your load balancers.

Type annotations and code completion for boto3.client("elbv2").describe_load_balancers method. boto3 documentation

# describe_load_balancers method definition

def describe_load_balancers(
    self,
    *,
    LoadBalancerArns: Sequence[str] = ...,
    Names: Sequence[str] = ...,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeLoadBalancersOutputTypeDef:  # (1)
    ...

1. See DescribeLoadBalancersOutputTypeDef

# describe_load_balancers method usage example with argument unpacking

kwargs: DescribeLoadBalancersInputRequestTypeDef = {  # (1)
    "LoadBalancerArns": ...,
}

parent.describe_load_balancers(**kwargs)

1. See DescribeLoadBalancersInputRequestTypeDef

describe_rules

Describes the specified rules or the rules for the specified listener.

Type annotations and code completion for boto3.client("elbv2").describe_rules method. boto3 documentation

# describe_rules method definition

def describe_rules(
    self,
    *,
    ListenerArn: str = ...,
    RuleArns: Sequence[str] = ...,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeRulesOutputTypeDef:  # (1)
    ...

1. See DescribeRulesOutputTypeDef

# describe_rules method usage example with argument unpacking

kwargs: DescribeRulesInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
}

parent.describe_rules(**kwargs)

1. See DescribeRulesInputRequestTypeDef

describe_ssl_policies

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

Type annotations and code completion for boto3.client("elbv2").describe_ssl_policies method. boto3 documentation

# describe_ssl_policies method definition

def describe_ssl_policies(
    self,
    *,
    Names: Sequence[str] = ...,
    Marker: str = ...,
    PageSize: int = ...,
    LoadBalancerType: LoadBalancerTypeEnumType = ...,  # (1)
) -> DescribeSSLPoliciesOutputTypeDef:  # (2)
    ...

1. See LoadBalancerTypeEnumType
2. See DescribeSSLPoliciesOutputTypeDef

# describe_ssl_policies method usage example with argument unpacking

kwargs: DescribeSSLPoliciesInputRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.describe_ssl_policies(**kwargs)

1. See DescribeSSLPoliciesInputRequestTypeDef

describe_tags

Describes the tags for the specified Elastic Load Balancing resources.

Type annotations and code completion for boto3.client("elbv2").describe_tags method. boto3 documentation

# describe_tags method definition

def describe_tags(
    self,
    *,
    ResourceArns: Sequence[str],
) -> DescribeTagsOutputTypeDef:  # (1)
    ...

1. See DescribeTagsOutputTypeDef

# describe_tags method usage example with argument unpacking

kwargs: DescribeTagsInputRequestTypeDef = {  # (1)
    "ResourceArns": ...,
}

parent.describe_tags(**kwargs)

1. See DescribeTagsInputRequestTypeDef

describe_target_group_attributes

Describes the attributes for the specified target group.

Type annotations and code completion for boto3.client("elbv2").describe_target_group_attributes method. boto3 documentation

# describe_target_group_attributes method definition

def describe_target_group_attributes(
    self,
    *,
    TargetGroupArn: str,
) -> DescribeTargetGroupAttributesOutputTypeDef:  # (1)
    ...

1. See DescribeTargetGroupAttributesOutputTypeDef

# describe_target_group_attributes method usage example with argument unpacking

kwargs: DescribeTargetGroupAttributesInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
}

parent.describe_target_group_attributes(**kwargs)

1. See DescribeTargetGroupAttributesInputRequestTypeDef

describe_target_groups

Describes the specified target groups or all of your target groups.

Type annotations and code completion for boto3.client("elbv2").describe_target_groups method. boto3 documentation

# describe_target_groups method definition

def describe_target_groups(
    self,
    *,
    LoadBalancerArn: str = ...,
    TargetGroupArns: Sequence[str] = ...,
    Names: Sequence[str] = ...,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeTargetGroupsOutputTypeDef:  # (1)
    ...

1. See DescribeTargetGroupsOutputTypeDef

# describe_target_groups method usage example with argument unpacking

kwargs: DescribeTargetGroupsInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.describe_target_groups(**kwargs)

1. See DescribeTargetGroupsInputRequestTypeDef

describe_target_health

Describes the health of the specified targets or all of your targets.

Type annotations and code completion for boto3.client("elbv2").describe_target_health method. boto3 documentation

# describe_target_health method definition

def describe_target_health(
    self,
    *,
    TargetGroupArn: str,
    Targets: Sequence[TargetDescriptionTypeDef] = ...,  # (1)
    Include: Sequence[DescribeTargetHealthInputIncludeEnumType] = ...,  # (2)
) -> DescribeTargetHealthOutputTypeDef:  # (3)
    ...

1. See TargetDescriptionTypeDef
2. See DescribeTargetHealthInputIncludeEnumType
3. See DescribeTargetHealthOutputTypeDef

# describe_target_health method usage example with argument unpacking

kwargs: DescribeTargetHealthInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
}

parent.describe_target_health(**kwargs)

1. See DescribeTargetHealthInputRequestTypeDef

describe_trust_store_associations

Describes all resources associated with the specified trust store.

Type annotations and code completion for boto3.client("elbv2").describe_trust_store_associations method. boto3 documentation

# describe_trust_store_associations method definition

def describe_trust_store_associations(
    self,
    *,
    TrustStoreArn: str,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeTrustStoreAssociationsOutputTypeDef:  # (1)
    ...

1. See DescribeTrustStoreAssociationsOutputTypeDef

# describe_trust_store_associations method usage example with argument unpacking

kwargs: DescribeTrustStoreAssociationsInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
}

parent.describe_trust_store_associations(**kwargs)

1. See DescribeTrustStoreAssociationsInputRequestTypeDef

describe_trust_store_revocations

Describes the revocation files in use by the specified trust store or revocation files.

Type annotations and code completion for boto3.client("elbv2").describe_trust_store_revocations method. boto3 documentation

# describe_trust_store_revocations method definition

def describe_trust_store_revocations(
    self,
    *,
    TrustStoreArn: str,
    RevocationIds: Sequence[int] = ...,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeTrustStoreRevocationsOutputTypeDef:  # (1)
    ...

1. See DescribeTrustStoreRevocationsOutputTypeDef

# describe_trust_store_revocations method usage example with argument unpacking

kwargs: DescribeTrustStoreRevocationsInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
}

parent.describe_trust_store_revocations(**kwargs)

1. See DescribeTrustStoreRevocationsInputRequestTypeDef

describe_trust_stores

Describes all trust stores for the specified account.

Type annotations and code completion for boto3.client("elbv2").describe_trust_stores method. boto3 documentation

# describe_trust_stores method definition

def describe_trust_stores(
    self,
    *,
    TrustStoreArns: Sequence[str] = ...,
    Names: Sequence[str] = ...,
    Marker: str = ...,
    PageSize: int = ...,
) -> DescribeTrustStoresOutputTypeDef:  # (1)
    ...

1. See DescribeTrustStoresOutputTypeDef

# describe_trust_stores method usage example with argument unpacking

kwargs: DescribeTrustStoresInputRequestTypeDef = {  # (1)
    "TrustStoreArns": ...,
}

parent.describe_trust_stores(**kwargs)

1. See DescribeTrustStoresInputRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("elbv2").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_resource_policy

Retrieves the resource policy for a specified resource.

Type annotations and code completion for boto3.client("elbv2").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyOutputTypeDef:  # (1)
    ...

1. See GetResourcePolicyOutputTypeDef

# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyInputRequestTypeDef

get_trust_store_ca_certificates_bundle

Retrieves the ca certificate bundle.

Type annotations and code completion for boto3.client("elbv2").get_trust_store_ca_certificates_bundle method. boto3 documentation

# get_trust_store_ca_certificates_bundle method definition

def get_trust_store_ca_certificates_bundle(
    self,
    *,
    TrustStoreArn: str,
) -> GetTrustStoreCaCertificatesBundleOutputTypeDef:  # (1)
    ...

1. See GetTrustStoreCaCertificatesBundleOutputTypeDef

# get_trust_store_ca_certificates_bundle method usage example with argument unpacking

kwargs: GetTrustStoreCaCertificatesBundleInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
}

parent.get_trust_store_ca_certificates_bundle(**kwargs)

1. See GetTrustStoreCaCertificatesBundleInputRequestTypeDef

get_trust_store_revocation_content

Retrieves the specified revocation file.

Type annotations and code completion for boto3.client("elbv2").get_trust_store_revocation_content method. boto3 documentation

# get_trust_store_revocation_content method definition

def get_trust_store_revocation_content(
    self,
    *,
    TrustStoreArn: str,
    RevocationId: int,
) -> GetTrustStoreRevocationContentOutputTypeDef:  # (1)
    ...

1. See GetTrustStoreRevocationContentOutputTypeDef

# get_trust_store_revocation_content method usage example with argument unpacking

kwargs: GetTrustStoreRevocationContentInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
    "RevocationId": ...,
}

parent.get_trust_store_revocation_content(**kwargs)

1. See GetTrustStoreRevocationContentInputRequestTypeDef

modify_capacity_reservation

Modifies the capacity reservation of the specified load balancer.

Type annotations and code completion for boto3.client("elbv2").modify_capacity_reservation method. boto3 documentation

# modify_capacity_reservation method definition

def modify_capacity_reservation(
    self,
    *,
    LoadBalancerArn: str,
    MinimumLoadBalancerCapacity: MinimumLoadBalancerCapacityTypeDef = ...,  # (1)
    ResetCapacityReservation: bool = ...,
) -> ModifyCapacityReservationOutputTypeDef:  # (2)
    ...

1. See MinimumLoadBalancerCapacityTypeDef
2. See ModifyCapacityReservationOutputTypeDef

# modify_capacity_reservation method usage example with argument unpacking

kwargs: ModifyCapacityReservationInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.modify_capacity_reservation(**kwargs)

1. See ModifyCapacityReservationInputRequestTypeDef

modify_listener

Replaces the specified properties of the specified listener.

Type annotations and code completion for boto3.client("elbv2").modify_listener method. boto3 documentation

# modify_listener method definition

def modify_listener(
    self,
    *,
    ListenerArn: str,
    Port: int = ...,
    Protocol: ProtocolEnumType = ...,  # (1)
    SslPolicy: str = ...,
    Certificates: Sequence[CertificateTypeDef] = ...,  # (2)
    DefaultActions: Sequence[ActionTypeDef] = ...,  # (3)
    AlpnPolicy: Sequence[str] = ...,
    MutualAuthentication: MutualAuthenticationAttributesTypeDef = ...,  # (4)
) -> ModifyListenerOutputTypeDef:  # (5)
    ...

1. See ProtocolEnumType
2. See CertificateTypeDef
3. See ActionTypeDef
4. See MutualAuthenticationAttributesTypeDef
5. See ModifyListenerOutputTypeDef

# modify_listener method usage example with argument unpacking

kwargs: ModifyListenerInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
}

parent.modify_listener(**kwargs)

1. See ModifyListenerInputRequestTypeDef

modify_listener_attributes

Modifies the specified attributes of the specified listener.

Type annotations and code completion for boto3.client("elbv2").modify_listener_attributes method. boto3 documentation

# modify_listener_attributes method definition

def modify_listener_attributes(
    self,
    *,
    ListenerArn: str,
    Attributes: Sequence[ListenerAttributeTypeDef],  # (1)
) -> ModifyListenerAttributesOutputTypeDef:  # (2)
    ...

1. See ListenerAttributeTypeDef
2. See ModifyListenerAttributesOutputTypeDef

# modify_listener_attributes method usage example with argument unpacking

kwargs: ModifyListenerAttributesInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
    "Attributes": ...,
}

parent.modify_listener_attributes(**kwargs)

1. See ModifyListenerAttributesInputRequestTypeDef

modify_load_balancer_attributes

Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").modify_load_balancer_attributes method. boto3 documentation

# modify_load_balancer_attributes method definition

def modify_load_balancer_attributes(
    self,
    *,
    LoadBalancerArn: str,
    Attributes: Sequence[LoadBalancerAttributeTypeDef],  # (1)
) -> ModifyLoadBalancerAttributesOutputTypeDef:  # (2)
    ...

1. See LoadBalancerAttributeTypeDef
2. See ModifyLoadBalancerAttributesOutputTypeDef

# modify_load_balancer_attributes method usage example with argument unpacking

kwargs: ModifyLoadBalancerAttributesInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
    "Attributes": ...,
}

parent.modify_load_balancer_attributes(**kwargs)

1. See ModifyLoadBalancerAttributesInputRequestTypeDef

modify_rule

Replaces the specified properties of the specified rule.

Type annotations and code completion for boto3.client("elbv2").modify_rule method. boto3 documentation

# modify_rule method definition

def modify_rule(
    self,
    *,
    RuleArn: str,
    Conditions: Sequence[RuleConditionTypeDef] = ...,  # (1)
    Actions: Sequence[ActionTypeDef] = ...,  # (2)
) -> ModifyRuleOutputTypeDef:  # (3)
    ...

1. See RuleConditionTypeDef
2. See ActionTypeDef
3. See ModifyRuleOutputTypeDef

# modify_rule method usage example with argument unpacking

kwargs: ModifyRuleInputRequestTypeDef = {  # (1)
    "RuleArn": ...,
}

parent.modify_rule(**kwargs)

1. See ModifyRuleInputRequestTypeDef

modify_target_group

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

Type annotations and code completion for boto3.client("elbv2").modify_target_group method. boto3 documentation

# modify_target_group method definition

def modify_target_group(
    self,
    *,
    TargetGroupArn: str,
    HealthCheckProtocol: ProtocolEnumType = ...,  # (1)
    HealthCheckPort: str = ...,
    HealthCheckPath: str = ...,
    HealthCheckEnabled: bool = ...,
    HealthCheckIntervalSeconds: int = ...,
    HealthCheckTimeoutSeconds: int = ...,
    HealthyThresholdCount: int = ...,
    UnhealthyThresholdCount: int = ...,
    Matcher: MatcherTypeDef = ...,  # (2)
) -> ModifyTargetGroupOutputTypeDef:  # (3)
    ...

1. See ProtocolEnumType
2. See MatcherTypeDef
3. See ModifyTargetGroupOutputTypeDef

# modify_target_group method usage example with argument unpacking

kwargs: ModifyTargetGroupInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
}

parent.modify_target_group(**kwargs)

1. See ModifyTargetGroupInputRequestTypeDef

modify_target_group_attributes

Modifies the specified attributes of the specified target group.

Type annotations and code completion for boto3.client("elbv2").modify_target_group_attributes method. boto3 documentation

# modify_target_group_attributes method definition

def modify_target_group_attributes(
    self,
    *,
    TargetGroupArn: str,
    Attributes: Sequence[TargetGroupAttributeTypeDef],  # (1)
) -> ModifyTargetGroupAttributesOutputTypeDef:  # (2)
    ...

1. See TargetGroupAttributeTypeDef
2. See ModifyTargetGroupAttributesOutputTypeDef

# modify_target_group_attributes method usage example with argument unpacking

kwargs: ModifyTargetGroupAttributesInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
    "Attributes": ...,
}

parent.modify_target_group_attributes(**kwargs)

1. See ModifyTargetGroupAttributesInputRequestTypeDef

modify_trust_store

Update the ca certificate bundle for the specified trust store.

Type annotations and code completion for boto3.client("elbv2").modify_trust_store method. boto3 documentation

# modify_trust_store method definition

def modify_trust_store(
    self,
    *,
    TrustStoreArn: str,
    CaCertificatesBundleS3Bucket: str,
    CaCertificatesBundleS3Key: str,
    CaCertificatesBundleS3ObjectVersion: str = ...,
) -> ModifyTrustStoreOutputTypeDef:  # (1)
    ...

1. See ModifyTrustStoreOutputTypeDef

# modify_trust_store method usage example with argument unpacking

kwargs: ModifyTrustStoreInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
    "CaCertificatesBundleS3Bucket": ...,
    "CaCertificatesBundleS3Key": ...,
}

parent.modify_trust_store(**kwargs)

1. See ModifyTrustStoreInputRequestTypeDef

register_targets

Registers the specified targets with the specified target group.

Type annotations and code completion for boto3.client("elbv2").register_targets method. boto3 documentation

# register_targets method definition

def register_targets(
    self,
    *,
    TargetGroupArn: str,
    Targets: Sequence[TargetDescriptionTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TargetDescriptionTypeDef

# register_targets method usage example with argument unpacking

kwargs: RegisterTargetsInputRequestTypeDef = {  # (1)
    "TargetGroupArn": ...,
    "Targets": ...,
}

parent.register_targets(**kwargs)

1. See RegisterTargetsInputRequestTypeDef

remove_listener_certificates

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

Type annotations and code completion for boto3.client("elbv2").remove_listener_certificates method. boto3 documentation

# remove_listener_certificates method definition

def remove_listener_certificates(
    self,
    *,
    ListenerArn: str,
    Certificates: Sequence[CertificateTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See CertificateTypeDef

# remove_listener_certificates method usage example with argument unpacking

kwargs: RemoveListenerCertificatesInputRequestTypeDef = {  # (1)
    "ListenerArn": ...,
    "Certificates": ...,
}

parent.remove_listener_certificates(**kwargs)

1. See RemoveListenerCertificatesInputRequestTypeDef

remove_tags

Removes the specified tags from the specified Elastic Load Balancing resources.

Type annotations and code completion for boto3.client("elbv2").remove_tags method. boto3 documentation

# remove_tags method definition

def remove_tags(
    self,
    *,
    ResourceArns: Sequence[str],
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# remove_tags method usage example with argument unpacking

kwargs: RemoveTagsInputRequestTypeDef = {  # (1)
    "ResourceArns": ...,
    "TagKeys": ...,
}

parent.remove_tags(**kwargs)

1. See RemoveTagsInputRequestTypeDef

remove_trust_store_revocations

Removes the specified revocation file from the specified trust store.

Type annotations and code completion for boto3.client("elbv2").remove_trust_store_revocations method. boto3 documentation

# remove_trust_store_revocations method definition

def remove_trust_store_revocations(
    self,
    *,
    TrustStoreArn: str,
    RevocationIds: Sequence[int],
) -> Dict[str, Any]:
    ...

# remove_trust_store_revocations method usage example with argument unpacking

kwargs: RemoveTrustStoreRevocationsInputRequestTypeDef = {  # (1)
    "TrustStoreArn": ...,
    "RevocationIds": ...,
}

parent.remove_trust_store_revocations(**kwargs)

1. See RemoveTrustStoreRevocationsInputRequestTypeDef

set_ip_address_type

Sets the type of IP addresses used by the subnets of the specified load balancer.

Type annotations and code completion for boto3.client("elbv2").set_ip_address_type method. boto3 documentation

# set_ip_address_type method definition

def set_ip_address_type(
    self,
    *,
    LoadBalancerArn: str,
    IpAddressType: IpAddressTypeType,  # (1)
) -> SetIpAddressTypeOutputTypeDef:  # (2)
    ...

1. See IpAddressTypeType
2. See SetIpAddressTypeOutputTypeDef

# set_ip_address_type method usage example with argument unpacking

kwargs: SetIpAddressTypeInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
    "IpAddressType": ...,
}

parent.set_ip_address_type(**kwargs)

1. See SetIpAddressTypeInputRequestTypeDef

set_rule_priorities

Sets the priorities of the specified rules.

Type annotations and code completion for boto3.client("elbv2").set_rule_priorities method. boto3 documentation

# set_rule_priorities method definition

def set_rule_priorities(
    self,
    *,
    RulePriorities: Sequence[RulePriorityPairTypeDef],  # (1)
) -> SetRulePrioritiesOutputTypeDef:  # (2)
    ...

1. See RulePriorityPairTypeDef
2. See SetRulePrioritiesOutputTypeDef

# set_rule_priorities method usage example with argument unpacking

kwargs: SetRulePrioritiesInputRequestTypeDef = {  # (1)
    "RulePriorities": ...,
}

parent.set_rule_priorities(**kwargs)

1. See SetRulePrioritiesInputRequestTypeDef

set_security_groups

Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer.

Type annotations and code completion for boto3.client("elbv2").set_security_groups method. boto3 documentation

# set_security_groups method definition

def set_security_groups(
    self,
    *,
    LoadBalancerArn: str,
    SecurityGroups: Sequence[str],
    EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic: EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnumType = ...,  # (1)
) -> SetSecurityGroupsOutputTypeDef:  # (2)
    ...

1. See EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnumType
2. See SetSecurityGroupsOutputTypeDef

# set_security_groups method usage example with argument unpacking

kwargs: SetSecurityGroupsInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
    "SecurityGroups": ...,
}

parent.set_security_groups(**kwargs)

1. See SetSecurityGroupsInputRequestTypeDef

set_subnets

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer.

Type annotations and code completion for boto3.client("elbv2").set_subnets method. boto3 documentation

# set_subnets method definition

def set_subnets(
    self,
    *,
    LoadBalancerArn: str,
    Subnets: Sequence[str] = ...,
    SubnetMappings: Sequence[SubnetMappingTypeDef] = ...,  # (1)
    IpAddressType: IpAddressTypeType = ...,  # (2)
    EnablePrefixForIpv6SourceNat: EnablePrefixForIpv6SourceNatEnumType = ...,  # (3)
) -> SetSubnetsOutputTypeDef:  # (4)
    ...

1. See SubnetMappingTypeDef
2. See IpAddressTypeType
3. See EnablePrefixForIpv6SourceNatEnumType
4. See SetSubnetsOutputTypeDef

# set_subnets method usage example with argument unpacking

kwargs: SetSubnetsInputRequestTypeDef = {  # (1)
    "LoadBalancerArn": ...,
}

parent.set_subnets(**kwargs)

1. See SetSubnetsInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("elbv2").get_paginator method with overloads.

• client.get_paginator("describe_account_limits") -> DescribeAccountLimitsPaginator
• client.get_paginator("describe_listener_certificates") -> DescribeListenerCertificatesPaginator
• client.get_paginator("describe_listeners") -> DescribeListenersPaginator
• client.get_paginator("describe_load_balancers") -> DescribeLoadBalancersPaginator
• client.get_paginator("describe_rules") -> DescribeRulesPaginator
• client.get_paginator("describe_ssl_policies") -> DescribeSSLPoliciesPaginator
• client.get_paginator("describe_target_groups") -> DescribeTargetGroupsPaginator

get_waiter

Type annotations and code completion for boto3.client("elbv2").get_waiter method with overloads.

• client.get_waiter("load_balancer_available") -> LoadBalancerAvailableWaiter
• client.get_waiter("load_balancer_exists") -> LoadBalancerExistsWaiter
• client.get_waiter("load_balancers_deleted") -> LoadBalancersDeletedWaiter
• client.get_waiter("target_deregistered") -> TargetDeregisteredWaiter
• client.get_waiter("target_in_service") -> TargetInServiceWaiter