Skip to content

GlobalAcceleratorClient#

Index > GlobalAccelerator > GlobalAcceleratorClient

Auto-generated documentation for GlobalAccelerator type annotations stubs module mypy-boto3-globalaccelerator.

GlobalAcceleratorClient#

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

# GlobalAcceleratorClient usage example

from boto3.session import Session
from mypy_boto3_globalaccelerator.client import GlobalAcceleratorClient

def get_globalaccelerator_client() -> GlobalAcceleratorClient:
    return Session().client("globalaccelerator")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("globalaccelerator")

try:
    do_something(client)
except (
    client.exceptions.AcceleratorNotDisabledException,
    client.exceptions.AcceleratorNotFoundException,
    client.exceptions.AccessDeniedException,
    client.exceptions.AssociatedEndpointGroupFoundException,
    client.exceptions.AssociatedListenerFoundException,
    client.exceptions.AttachmentNotFoundException,
    client.exceptions.ByoipCidrNotFoundException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.EndpointAlreadyExistsException,
    client.exceptions.EndpointGroupAlreadyExistsException,
    client.exceptions.EndpointGroupNotFoundException,
    client.exceptions.EndpointNotFoundException,
    client.exceptions.IncorrectCidrStateException,
    client.exceptions.InternalServiceErrorException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidPortRangeException,
    client.exceptions.LimitExceededException,
    client.exceptions.ListenerNotFoundException,
    client.exceptions.TransactionInProgressException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_globalaccelerator.client import Exceptions

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

Methods#

add_custom_routing_endpoints#

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

Type annotations and code completion for boto3.client("globalaccelerator").add_custom_routing_endpoints method. boto3 documentation

# add_custom_routing_endpoints method definition

def add_custom_routing_endpoints(
    self,
    *,
    EndpointConfigurations: Sequence[CustomRoutingEndpointConfigurationTypeDef],  # (1)
    EndpointGroupArn: str,
) -> AddCustomRoutingEndpointsResponseTypeDef:  # (2)
    ...
  1. See CustomRoutingEndpointConfigurationTypeDef
  2. See AddCustomRoutingEndpointsResponseTypeDef 
# add_custom_routing_endpoints method usage example with argument unpacking

kwargs: AddCustomRoutingEndpointsRequestRequestTypeDef = {  # (1)
    "EndpointConfigurations": ...,
    "EndpointGroupArn": ...,
}

parent.add_custom_routing_endpoints(**kwargs)
  1. See AddCustomRoutingEndpointsRequestRequestTypeDef

add_endpoints#

Add endpoints to an endpoint group.

Type annotations and code completion for boto3.client("globalaccelerator").add_endpoints method. boto3 documentation

# add_endpoints method definition

def add_endpoints(
    self,
    *,
    EndpointConfigurations: Sequence[EndpointConfigurationTypeDef],  # (1)
    EndpointGroupArn: str,
) -> AddEndpointsResponseTypeDef:  # (2)
    ...
  1. See EndpointConfigurationTypeDef
  2. See AddEndpointsResponseTypeDef 
# add_endpoints method usage example with argument unpacking

kwargs: AddEndpointsRequestRequestTypeDef = {  # (1)
    "EndpointConfigurations": ...,
    "EndpointGroupArn": ...,
}

parent.add_endpoints(**kwargs)
  1. See AddEndpointsRequestRequestTypeDef

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

Type annotations and code completion for boto3.client("globalaccelerator").advertise_byoip_cidr method. boto3 documentation

# advertise_byoip_cidr method definition

def advertise_byoip_cidr(
    self,
    *,
    Cidr: str,
) -> AdvertiseByoipCidrResponseTypeDef:  # (1)
    ...
  1. See AdvertiseByoipCidrResponseTypeDef 
# advertise_byoip_cidr method usage example with argument unpacking

kwargs: AdvertiseByoipCidrRequestRequestTypeDef = {  # (1)
    "Cidr": ...,
}

parent.advertise_byoip_cidr(**kwargs)
  1. See AdvertiseByoipCidrRequestRequestTypeDef

allow_custom_routing_traffic#

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator.

Type annotations and code completion for boto3.client("globalaccelerator").allow_custom_routing_traffic method. boto3 documentation

# allow_custom_routing_traffic method definition

def allow_custom_routing_traffic(
    self,
    *,
    EndpointGroupArn: str,
    EndpointId: str,
    DestinationAddresses: Sequence[str] = ...,
    DestinationPorts: Sequence[int] = ...,
    AllowAllTrafficToEndpoint: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# allow_custom_routing_traffic method usage example with argument unpacking

kwargs: AllowCustomRoutingTrafficRequestRequestTypeDef = {  # (1)
    "EndpointGroupArn": ...,
    "EndpointId": ...,
}

parent.allow_custom_routing_traffic(**kwargs)
  1. See