GlobalAccelerator module#
Index > GlobalAccelerator
Auto-generated documentation for GlobalAccelerator type annotations stubs module mypy-boto3-globalaccelerator.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and GlobalAccelerator
.
From PyPI with pip#
Install boto3-stubs
for GlobalAccelerator
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[globalaccelerator]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[globalaccelerator]'
# standalone installation
python -m pip install mypy-boto3-globalaccelerator
How to uninstall#
python -m pip uninstall -y mypy-boto3-globalaccelerator
Usage#
Code samples can be found in Examples.
GlobalAcceleratorClient#
Type annotations and code completion for boto3.client("globalaccelerator")
as GlobalAcceleratorClient
boto3 documentation
# GlobalAcceleratorClient usage example
from boto3.session import Session
from mypy_boto3_globalaccelerator.client import GlobalAcceleratorClient
def get_client() -> GlobalAcceleratorClient:
return Session().client("globalaccelerator")
Paginators#
Type annotations and code completion for paginators
from boto3.client("globalaccelerator").get_paginator("...")
.
# ListAcceleratorsPaginator usage example
from boto3.session import Session
from mypy_boto3_globalaccelerator.paginator import ListAcceleratorsPaginator
def get_list_accelerators_paginator() -> ListAcceleratorsPaginator:
return Session().client("globalaccelerator").get_paginator("list_accelerators"))
- ListAcceleratorsPaginator
- ListByoipCidrsPaginator
- ListCustomRoutingAcceleratorsPaginator
- ListCustomRoutingListenersPaginator
- ListCustomRoutingPortMappingsPaginator
- ListCustomRoutingPortMappingsByDestinationPaginator
- ListEndpointGroupsPaginator
- ListListenersPaginator
Literals#
Type annotations for literals used in methods and schemas.
# AcceleratorStatusType usage example
from mypy_boto3_globalaccelerator.literals import AcceleratorStatusType
def get_value() -> AcceleratorStatusType:
return "DEPLOYED"
- AcceleratorStatusType
- ByoipCidrStateType
- ClientAffinityType
- CustomRoutingAcceleratorStatusType
- CustomRoutingDestinationTrafficStateType
- CustomRoutingProtocolType
- HealthCheckProtocolType
- HealthStateType
- IpAddressFamilyType
- IpAddressTypeType
- ListAcceleratorsPaginatorName
- ListByoipCidrsPaginatorName
- ListCustomRoutingAcceleratorsPaginatorName
- ListCustomRoutingListenersPaginatorName
- ListCustomRoutingPortMappingsByDestinationPaginatorName
- ListCustomRoutingPortMappingsPaginatorName
- ListEndpointGroupsPaginatorName
- ListListenersPaginatorName
- ProtocolType
- GlobalAcceleratorServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AcceleratorAttributesTypeDef usage example
from mypy_boto3_globalaccelerator.type_defs import AcceleratorAttributesTypeDef
def get_value() -> AcceleratorAttributesTypeDef:
return {
"FlowLogsEnabled": ...,
}
- AcceleratorAttributesTypeDef
- AcceleratorEventTypeDef
- IpSetTypeDef
- CustomRoutingEndpointConfigurationTypeDef
- CustomRoutingEndpointDescriptionTypeDef
- EndpointConfigurationTypeDef
- EndpointDescriptionTypeDef
- AdvertiseByoipCidrRequestRequestTypeDef
- AllowCustomRoutingTrafficRequestRequestTypeDef
- ByoipCidrEventTypeDef
- CidrAuthorizationContextTypeDef
- TagTypeDef
- CustomRoutingDestinationConfigurationTypeDef
- PortRangeTypeDef
- PortOverrideTypeDef
- CustomRoutingAcceleratorAttributesTypeDef
- CustomRoutingDestinationDescriptionTypeDef
- DeleteAcceleratorRequestRequestTypeDef
- DeleteCustomRoutingAcceleratorRequestRequestTypeDef
- DeleteCustomRoutingEndpointGroupRequestRequestTypeDef
- DeleteCustomRoutingListenerRequestRequestTypeDef
- DeleteEndpointGroupRequestRequestTypeDef
- DeleteListenerRequestRequestTypeDef
- DenyCustomRoutingTrafficRequestRequestTypeDef
- DeprovisionByoipCidrRequestRequestTypeDef
- DescribeAcceleratorAttributesRequestRequestTypeDef
- DescribeAcceleratorRequestRequestTypeDef
- DescribeCustomRoutingAcceleratorAttributesRequestRequestTypeDef
- DescribeCustomRoutingAcceleratorRequestRequestTypeDef
- DescribeCustomRoutingEndpointGroupRequestRequestTypeDef
- DescribeCustomRoutingListenerRequestRequestTypeDef
- DescribeEndpointGroupRequestRequestTypeDef
- DescribeListenerRequestRequestTypeDef
- SocketAddressTypeDef
- EmptyResponseMetadataTypeDef
- EndpointIdentifierTypeDef
- ListAcceleratorsRequestListAcceleratorsPaginateTypeDef
- ListAcceleratorsRequestRequestTypeDef
- ListByoipCidrsRequestListByoipCidrsPaginateTypeDef
- ListByoipCidrsRequestRequestTypeDef
- ListCustomRoutingAcceleratorsRequestListCustomRoutingAcceleratorsPaginateTypeDef
- ListCustomRoutingAcceleratorsRequestRequestTypeDef
- ListCustomRoutingEndpointGroupsRequestRequestTypeDef
- ListCustomRoutingListenersRequestListCustomRoutingListenersPaginateTypeDef
- ListCustomRoutingListenersRequestRequestTypeDef
- ListCustomRoutingPortMappingsByDestinationRequestListCustomRoutingPortMappingsByDestinationPaginateTypeDef
- ListCustomRoutingPortMappingsByDestinationRequestRequestTypeDef
- ListCustomRoutingPortMappingsRequestListCustomRoutingPortMappingsPaginateTypeDef
- ListCustomRoutingPortMappingsRequestRequestTypeDef
- ListEndpointGroupsRequestListEndpointGroupsPaginateTypeDef
- ListEndpointGroupsRequestRequestTypeDef
- ListListenersRequestListListenersPaginateTypeDef
- ListListenersRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PaginatorConfigTypeDef
- RemoveCustomRoutingEndpointsRequestRequestTypeDef
- ResponseMetadataTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAcceleratorAttributesRequestRequestTypeDef
- UpdateAcceleratorRequestRequestTypeDef
- UpdateCustomRoutingAcceleratorAttributesRequestRequestTypeDef
- UpdateCustomRoutingAcceleratorRequestRequestTypeDef
- WithdrawByoipCidrRequestRequestTypeDef
- DescribeAcceleratorAttributesResponseTypeDef
- UpdateAcceleratorAttributesResponseTypeDef
- AcceleratorTypeDef
- CustomRoutingAcceleratorTypeDef
- AddCustomRoutingEndpointsRequestRequestTypeDef
- AddCustomRoutingEndpointsResponseTypeDef
- AddEndpointsRequestRequestTypeDef
- AddEndpointsResponseTypeDef
- ByoipCidrTypeDef
- ProvisionByoipCidrRequestRequestTypeDef
- CreateAcceleratorRequestRequestTypeDef
- CreateCustomRoutingAcceleratorRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateCustomRoutingEndpointGroupRequestRequestTypeDef
- CreateCustomRoutingListenerRequestRequestTypeDef
- CreateListenerRequestRequestTypeDef
- CustomRoutingListenerTypeDef
- ListenerTypeDef
- UpdateCustomRoutingListenerRequestRequestTypeDef
- UpdateListenerRequestRequestTypeDef
- CreateEndpointGroupRequestRequestTypeDef
- EndpointGroupTypeDef
- UpdateEndpointGroupRequestRequestTypeDef
- DescribeCustomRoutingAcceleratorAttributesResponseTypeDef
- UpdateCustomRoutingAcceleratorAttributesResponseTypeDef
- CustomRoutingEndpointGroupTypeDef
- DestinationPortMappingTypeDef
- PortMappingTypeDef
- RemoveEndpointsRequestRequestTypeDef
- CreateAcceleratorResponseTypeDef
- DescribeAcceleratorResponseTypeDef
- ListAcceleratorsResponseTypeDef
- UpdateAcceleratorResponseTypeDef
- CreateCustomRoutingAcceleratorResponseTypeDef
- DescribeCustomRoutingAcceleratorResponseTypeDef
- ListCustomRoutingAcceleratorsResponseTypeDef
- UpdateCustomRoutingAcceleratorResponseTypeDef
- AdvertiseByoipCidrResponseTypeDef
- DeprovisionByoipCidrResponseTypeDef
- ListByoipCidrsResponseTypeDef
- ProvisionByoipCidrResponseTypeDef
- WithdrawByoipCidrResponseTypeDef
- CreateCustomRoutingListenerResponseTypeDef
- DescribeCustomRoutingListenerResponseTypeDef
- ListCustomRoutingListenersResponseTypeDef
- UpdateCustomRoutingListenerResponseTypeDef
- CreateListenerResponseTypeDef
- DescribeListenerResponseTypeDef
- ListListenersResponseTypeDef
- UpdateListenerResponseTypeDef
- CreateEndpointGroupResponseTypeDef
- DescribeEndpointGroupResponseTypeDef
- ListEndpointGroupsResponseTypeDef
- UpdateEndpointGroupResponseTypeDef
- CreateCustomRoutingEndpointGroupResponseTypeDef
- DescribeCustomRoutingEndpointGroupResponseTypeDef
- ListCustomRoutingEndpointGroupsResponseTypeDef
- ListCustomRoutingPortMappingsByDestinationResponseTypeDef
- ListCustomRoutingPortMappingsResponseTypeDef