Type definitions#
Index > ElasticLoadBalancing > Type definitions
Auto-generated documentation for ElasticLoadBalancing type annotations stubs module types-boto3-elb.
AccessLogTypeDef#
# AccessLogTypeDef definition
class AccessLogTypeDef(TypedDict):
Enabled: bool,
S3BucketName: NotRequired[str],
EmitInterval: NotRequired[int],
S3BucketPrefix: NotRequired[str],
AddAvailabilityZonesInputRequestTypeDef#
# AddAvailabilityZonesInputRequestTypeDef definition
class AddAvailabilityZonesInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
AvailabilityZones: Sequence[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: NotRequired[str],
AdditionalAttributeTypeDef#
# AdditionalAttributeTypeDef definition
class AdditionalAttributeTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
AppCookieStickinessPolicyTypeDef#
# AppCookieStickinessPolicyTypeDef definition
class AppCookieStickinessPolicyTypeDef(TypedDict):
PolicyName: NotRequired[str],
CookieName: NotRequired[str],
ApplySecurityGroupsToLoadBalancerInputRequestTypeDef#
# ApplySecurityGroupsToLoadBalancerInputRequestTypeDef definition
class ApplySecurityGroupsToLoadBalancerInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
SecurityGroups: Sequence[str],
AttachLoadBalancerToSubnetsInputRequestTypeDef#
# AttachLoadBalancerToSubnetsInputRequestTypeDef definition
class AttachLoadBalancerToSubnetsInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Subnets: Sequence[str],
BackendServerDescriptionTypeDef#
# BackendServerDescriptionTypeDef definition
class BackendServerDescriptionTypeDef(TypedDict):
InstancePort: NotRequired[int],
PolicyNames: NotRequired[list[str]],
HealthCheckTypeDef#
# HealthCheckTypeDef definition
class HealthCheckTypeDef(TypedDict):
Target: str,
Interval: int,
Timeout: int,
UnhealthyThreshold: int,
HealthyThreshold: int,
ConnectionDrainingTypeDef#
# ConnectionDrainingTypeDef definition
class ConnectionDrainingTypeDef(TypedDict):
Enabled: bool,
Timeout: NotRequired[int],
ConnectionSettingsTypeDef#
# ConnectionSettingsTypeDef definition
class ConnectionSettingsTypeDef(TypedDict):
IdleTimeout: int,
ListenerTypeDef#
# ListenerTypeDef definition
class ListenerTypeDef(TypedDict):
Protocol: str,
LoadBalancerPort: int,
InstancePort: int,
InstanceProtocol: NotRequired[str],
SSLCertificateId: NotRequired[str],
CreateAppCookieStickinessPolicyInputRequestTypeDef#
# CreateAppCookieStickinessPolicyInputRequestTypeDef definition
class CreateAppCookieStickinessPolicyInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
PolicyName: str,
CookieName: str,
CreateLBCookieStickinessPolicyInputRequestTypeDef#
# CreateLBCookieStickinessPolicyInputRequestTypeDef definition
class CreateLBCookieStickinessPolicyInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
PolicyName: str,
CookieExpirationPeriod: NotRequired[int],
PolicyAttributeTypeDef#
# PolicyAttributeTypeDef definition
class PolicyAttributeTypeDef(TypedDict):
AttributeName: NotRequired[str],
AttributeValue: NotRequired[str],
CrossZoneLoadBalancingTypeDef#
# CrossZoneLoadBalancingTypeDef definition
class CrossZoneLoadBalancingTypeDef(TypedDict):
Enabled: bool,
DeleteAccessPointInputRequestTypeDef#
# DeleteAccessPointInputRequestTypeDef definition
class DeleteAccessPointInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
DeleteLoadBalancerListenerInputRequestTypeDef#
# DeleteLoadBalancerListenerInputRequestTypeDef definition
class DeleteLoadBalancerListenerInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
LoadBalancerPorts: Sequence[int],
DeleteLoadBalancerPolicyInputRequestTypeDef#
# DeleteLoadBalancerPolicyInputRequestTypeDef definition
class DeleteLoadBalancerPolicyInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
PolicyName: str,
InstanceTypeDef#
# InstanceTypeDef definition
class InstanceTypeDef(TypedDict):
InstanceId: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeAccessPointsInputRequestTypeDef#
# DescribeAccessPointsInputRequestTypeDef definition
class DescribeAccessPointsInputRequestTypeDef(TypedDict):
LoadBalancerNames: NotRequired[Sequence[str]],
Marker: NotRequired[str],
PageSize: NotRequired[int],
DescribeAccountLimitsInputRequestTypeDef#
# DescribeAccountLimitsInputRequestTypeDef definition
class DescribeAccountLimitsInputRequestTypeDef(TypedDict):
Marker: NotRequired[str],
PageSize: NotRequired[int],
LimitTypeDef#
# LimitTypeDef definition
class LimitTypeDef(TypedDict):
Name: NotRequired[str],
Max: NotRequired[str],
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
InstanceStateTypeDef#
# InstanceStateTypeDef definition
class InstanceStateTypeDef(TypedDict):
InstanceId: NotRequired[str],
State: NotRequired[str],
ReasonCode: NotRequired[str],
Description: NotRequired[str],
DescribeLoadBalancerAttributesInputRequestTypeDef#
# DescribeLoadBalancerAttributesInputRequestTypeDef definition
class DescribeLoadBalancerAttributesInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
DescribeLoadBalancerPoliciesInputRequestTypeDef#
# DescribeLoadBalancerPoliciesInputRequestTypeDef definition
class DescribeLoadBalancerPoliciesInputRequestTypeDef(TypedDict):
LoadBalancerName: NotRequired[str],
PolicyNames: NotRequired[Sequence[str]],
DescribeLoadBalancerPolicyTypesInputRequestTypeDef#
# DescribeLoadBalancerPolicyTypesInputRequestTypeDef definition
class DescribeLoadBalancerPolicyTypesInputRequestTypeDef(TypedDict):
PolicyTypeNames: NotRequired[Sequence[str]],
DescribeTagsInputRequestTypeDef#
# DescribeTagsInputRequestTypeDef definition
class DescribeTagsInputRequestTypeDef(TypedDict):
LoadBalancerNames: Sequence[str],
DetachLoadBalancerFromSubnetsInputRequestTypeDef#
# DetachLoadBalancerFromSubnetsInputRequestTypeDef definition
class DetachLoadBalancerFromSubnetsInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Subnets: Sequence[str],
LBCookieStickinessPolicyTypeDef#
# LBCookieStickinessPolicyTypeDef definition
class LBCookieStickinessPolicyTypeDef(TypedDict):
PolicyName: NotRequired[str],
CookieExpirationPeriod: NotRequired[int],
SourceSecurityGroupTypeDef#
# SourceSecurityGroupTypeDef definition
class SourceSecurityGroupTypeDef(TypedDict):
OwnerAlias: NotRequired[str],
GroupName: NotRequired[str],
PolicyAttributeDescriptionTypeDef#
# PolicyAttributeDescriptionTypeDef definition
class PolicyAttributeDescriptionTypeDef(TypedDict):
AttributeName: NotRequired[str],
AttributeValue: NotRequired[str],
PolicyAttributeTypeDescriptionTypeDef#
# PolicyAttributeTypeDescriptionTypeDef definition
class PolicyAttributeTypeDescriptionTypeDef(TypedDict):
AttributeName: NotRequired[str],
AttributeType: NotRequired[str],
Description: NotRequired[str],
DefaultValue: NotRequired[str],
Cardinality: NotRequired[str],
RemoveAvailabilityZonesInputRequestTypeDef#
# RemoveAvailabilityZonesInputRequestTypeDef definition
class RemoveAvailabilityZonesInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
AvailabilityZones: Sequence[str],
TagKeyOnlyTypeDef#
# TagKeyOnlyTypeDef definition
class TagKeyOnlyTypeDef(TypedDict):
Key: NotRequired[str],
SetLoadBalancerListenerSSLCertificateInputRequestTypeDef#
# SetLoadBalancerListenerSSLCertificateInputRequestTypeDef definition
class SetLoadBalancerListenerSSLCertificateInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
LoadBalancerPort: int,
SSLCertificateId: str,
SetLoadBalancerPoliciesForBackendServerInputRequestTypeDef#
# SetLoadBalancerPoliciesForBackendServerInputRequestTypeDef definition
class SetLoadBalancerPoliciesForBackendServerInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
InstancePort: int,
PolicyNames: Sequence[str],
SetLoadBalancerPoliciesOfListenerInputRequestTypeDef#
# SetLoadBalancerPoliciesOfListenerInputRequestTypeDef definition
class SetLoadBalancerPoliciesOfListenerInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
LoadBalancerPort: int,
PolicyNames: Sequence[str],
AddAvailabilityZonesOutputTypeDef#
# AddAvailabilityZonesOutputTypeDef definition
class AddAvailabilityZonesOutputTypeDef(TypedDict):
AvailabilityZones: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ApplySecurityGroupsToLoadBalancerOutputTypeDef#
# ApplySecurityGroupsToLoadBalancerOutputTypeDef definition
class ApplySecurityGroupsToLoadBalancerOutputTypeDef(TypedDict):
SecurityGroups: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AttachLoadBalancerToSubnetsOutputTypeDef#
# AttachLoadBalancerToSubnetsOutputTypeDef definition
class AttachLoadBalancerToSubnetsOutputTypeDef(TypedDict):
Subnets: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAccessPointOutputTypeDef#
# CreateAccessPointOutputTypeDef definition
class CreateAccessPointOutputTypeDef(TypedDict):
DNSName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DetachLoadBalancerFromSubnetsOutputTypeDef#
# DetachLoadBalancerFromSubnetsOutputTypeDef definition
class DetachLoadBalancerFromSubnetsOutputTypeDef(TypedDict):
Subnets: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RemoveAvailabilityZonesOutputTypeDef#
# RemoveAvailabilityZonesOutputTypeDef definition
class RemoveAvailabilityZonesOutputTypeDef(TypedDict):
AvailabilityZones: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AddTagsInputRequestTypeDef#
# AddTagsInputRequestTypeDef definition
class AddTagsInputRequestTypeDef(TypedDict):
LoadBalancerNames: Sequence[str],
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
TagDescriptionTypeDef#
# TagDescriptionTypeDef definition
class TagDescriptionTypeDef(TypedDict):
LoadBalancerName: NotRequired[str],
Tags: NotRequired[list[TagTypeDef]], # (1)
- See TagTypeDef
ConfigureHealthCheckInputRequestTypeDef#
# ConfigureHealthCheckInputRequestTypeDef definition
class ConfigureHealthCheckInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
HealthCheck: HealthCheckTypeDef, # (1)
ConfigureHealthCheckOutputTypeDef#
# ConfigureHealthCheckOutputTypeDef definition
class ConfigureHealthCheckOutputTypeDef(TypedDict):
HealthCheck: HealthCheckTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAccessPointInputRequestTypeDef#
# CreateAccessPointInputRequestTypeDef definition
class CreateAccessPointInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Listeners: Sequence[ListenerTypeDef], # (1)
AvailabilityZones: NotRequired[Sequence[str]],
Subnets: NotRequired[Sequence[str]],
SecurityGroups: NotRequired[Sequence[str]],
Scheme: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See ListenerTypeDef
- See TagTypeDef
CreateLoadBalancerListenerInputRequestTypeDef#
# CreateLoadBalancerListenerInputRequestTypeDef definition
class CreateLoadBalancerListenerInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Listeners: Sequence[ListenerTypeDef], # (1)
- See ListenerTypeDef
ListenerDescriptionTypeDef#
# ListenerDescriptionTypeDef definition
class ListenerDescriptionTypeDef(TypedDict):
Listener: NotRequired[ListenerTypeDef], # (1)
PolicyNames: NotRequired[list[str]],
- See ListenerTypeDef
CreateLoadBalancerPolicyInputRequestTypeDef#
# CreateLoadBalancerPolicyInputRequestTypeDef definition
class CreateLoadBalancerPolicyInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
PolicyName: str,
PolicyTypeName: str,
PolicyAttributes: NotRequired[Sequence[PolicyAttributeTypeDef]], # (1)
LoadBalancerAttributesOutputTypeDef#
# LoadBalancerAttributesOutputTypeDef definition
class LoadBalancerAttributesOutputTypeDef(TypedDict):
CrossZoneLoadBalancing: NotRequired[CrossZoneLoadBalancingTypeDef], # (1)
AccessLog: NotRequired[AccessLogTypeDef], # (2)
ConnectionDraining: NotRequired[ConnectionDrainingTypeDef], # (3)
ConnectionSettings: NotRequired[ConnectionSettingsTypeDef], # (4)
AdditionalAttributes: NotRequired[list[AdditionalAttributeTypeDef]], # (5)
- See CrossZoneLoadBalancingTypeDef
- See AccessLogTypeDef
- See ConnectionDrainingTypeDef
- See ConnectionSettingsTypeDef
- See AdditionalAttributeTypeDef
LoadBalancerAttributesTypeDef#
# LoadBalancerAttributesTypeDef definition
class LoadBalancerAttributesTypeDef(TypedDict):
CrossZoneLoadBalancing: NotRequired[CrossZoneLoadBalancingTypeDef], # (1)
AccessLog: NotRequired[AccessLogTypeDef], # (2)
ConnectionDraining: NotRequired[ConnectionDrainingTypeDef], # (3)
ConnectionSettings: NotRequired[ConnectionSettingsTypeDef], # (4)
AdditionalAttributes: NotRequired[Sequence[AdditionalAttributeTypeDef]], # (5)
- See CrossZoneLoadBalancingTypeDef
- See AccessLogTypeDef
- See ConnectionDrainingTypeDef
- See ConnectionSettingsTypeDef
- See AdditionalAttributeTypeDef
DeregisterEndPointsInputRequestTypeDef#
# DeregisterEndPointsInputRequestTypeDef definition
class DeregisterEndPointsInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Instances: Sequence[InstanceTypeDef], # (1)
- See InstanceTypeDef
DeregisterEndPointsOutputTypeDef#
# DeregisterEndPointsOutputTypeDef definition
class DeregisterEndPointsOutputTypeDef(TypedDict):
Instances: list[InstanceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeEndPointStateInputRequestTypeDef#
# DescribeEndPointStateInputRequestTypeDef definition
class DescribeEndPointStateInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Instances: NotRequired[Sequence[InstanceTypeDef]], # (1)
- See InstanceTypeDef
RegisterEndPointsInputRequestTypeDef#
# RegisterEndPointsInputRequestTypeDef definition
class RegisterEndPointsInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
Instances: Sequence[InstanceTypeDef], # (1)
- See InstanceTypeDef
RegisterEndPointsOutputTypeDef#
# RegisterEndPointsOutputTypeDef definition
class RegisterEndPointsOutputTypeDef(TypedDict):
Instances: list[InstanceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAccessPointsInputPaginateTypeDef#
# DescribeAccessPointsInputPaginateTypeDef definition
class DescribeAccessPointsInputPaginateTypeDef(TypedDict):
LoadBalancerNames: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeAccountLimitsInputPaginateTypeDef#
# DescribeAccountLimitsInputPaginateTypeDef definition
class DescribeAccountLimitsInputPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeAccountLimitsOutputTypeDef#
# DescribeAccountLimitsOutputTypeDef definition
class DescribeAccountLimitsOutputTypeDef(TypedDict):
Limits: list[LimitTypeDef], # (1)
NextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See LimitTypeDef
- See ResponseMetadataTypeDef
DescribeEndPointStateInputWaitTypeDef#
# DescribeEndPointStateInputWaitTypeDef definition
class DescribeEndPointStateInputWaitTypeDef(TypedDict):
LoadBalancerName: str,
Instances: NotRequired[Sequence[InstanceTypeDef]], # (1)
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (2)
- See InstanceTypeDef
- See WaiterConfigTypeDef
DescribeEndPointStateOutputTypeDef#
# DescribeEndPointStateOutputTypeDef definition
class DescribeEndPointStateOutputTypeDef(TypedDict):
InstanceStates: list[InstanceStateTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PoliciesTypeDef#
# PoliciesTypeDef definition
class PoliciesTypeDef(TypedDict):
AppCookieStickinessPolicies: NotRequired[list[AppCookieStickinessPolicyTypeDef]], # (1)
LBCookieStickinessPolicies: NotRequired[list[LBCookieStickinessPolicyTypeDef]], # (2)
OtherPolicies: NotRequired[list[str]],
PolicyDescriptionTypeDef#
# PolicyDescriptionTypeDef definition
class PolicyDescriptionTypeDef(TypedDict):
PolicyName: NotRequired[str],
PolicyTypeName: NotRequired[str],
PolicyAttributeDescriptions: NotRequired[list[PolicyAttributeDescriptionTypeDef]], # (1)
PolicyTypeDescriptionTypeDef#
# PolicyTypeDescriptionTypeDef definition
class PolicyTypeDescriptionTypeDef(TypedDict):
PolicyTypeName: NotRequired[str],
Description: NotRequired[str],
PolicyAttributeTypeDescriptions: NotRequired[list[PolicyAttributeTypeDescriptionTypeDef]], # (1)
RemoveTagsInputRequestTypeDef#
# RemoveTagsInputRequestTypeDef definition
class RemoveTagsInputRequestTypeDef(TypedDict):
LoadBalancerNames: Sequence[str],
Tags: Sequence[TagKeyOnlyTypeDef], # (1)
DescribeTagsOutputTypeDef#
# DescribeTagsOutputTypeDef definition
class DescribeTagsOutputTypeDef(TypedDict):
TagDescriptions: list[TagDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeLoadBalancerAttributesOutputTypeDef#
# DescribeLoadBalancerAttributesOutputTypeDef definition
class DescribeLoadBalancerAttributesOutputTypeDef(TypedDict):
LoadBalancerAttributes: LoadBalancerAttributesOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyLoadBalancerAttributesOutputTypeDef#
# ModifyLoadBalancerAttributesOutputTypeDef definition
class ModifyLoadBalancerAttributesOutputTypeDef(TypedDict):
LoadBalancerName: str,
LoadBalancerAttributes: LoadBalancerAttributesOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyLoadBalancerAttributesInputRequestTypeDef#
# ModifyLoadBalancerAttributesInputRequestTypeDef definition
class ModifyLoadBalancerAttributesInputRequestTypeDef(TypedDict):
LoadBalancerName: str,
LoadBalancerAttributes: LoadBalancerAttributesTypeDef, # (1)
LoadBalancerDescriptionTypeDef#
# LoadBalancerDescriptionTypeDef definition
class LoadBalancerDescriptionTypeDef(TypedDict):
LoadBalancerName: NotRequired[str],
DNSName: NotRequired[str],
CanonicalHostedZoneName: NotRequired[str],
CanonicalHostedZoneNameID: NotRequired[str],
ListenerDescriptions: NotRequired[list[ListenerDescriptionTypeDef]], # (1)
Policies: NotRequired[PoliciesTypeDef], # (2)
BackendServerDescriptions: NotRequired[list[BackendServerDescriptionTypeDef]], # (3)
AvailabilityZones: NotRequired[list[str]],
Subnets: NotRequired[list[str]],
VPCId: NotRequired[str],
Instances: NotRequired[list[InstanceTypeDef]], # (4)
HealthCheck: NotRequired[HealthCheckTypeDef], # (5)
SourceSecurityGroup: NotRequired[SourceSecurityGroupTypeDef], # (6)
SecurityGroups: NotRequired[list[str]],
CreatedTime: NotRequired[datetime],
Scheme: NotRequired[str],
- See ListenerDescriptionTypeDef
- See PoliciesTypeDef
- See BackendServerDescriptionTypeDef
- See InstanceTypeDef
- See HealthCheckTypeDef
- See SourceSecurityGroupTypeDef
DescribeLoadBalancerPoliciesOutputTypeDef#
# DescribeLoadBalancerPoliciesOutputTypeDef definition
class DescribeLoadBalancerPoliciesOutputTypeDef(TypedDict):
PolicyDescriptions: list[PolicyDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeLoadBalancerPolicyTypesOutputTypeDef#
# DescribeLoadBalancerPolicyTypesOutputTypeDef definition
class DescribeLoadBalancerPolicyTypesOutputTypeDef(TypedDict):
PolicyTypeDescriptions: list[PolicyTypeDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAccessPointsOutputTypeDef#
# DescribeAccessPointsOutputTypeDef definition
class DescribeAccessPointsOutputTypeDef(TypedDict):
LoadBalancerDescriptions: list[LoadBalancerDescriptionTypeDef], # (1)
NextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)