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.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

advertise_byoip_cidr

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 AllowCustomRoutingTrafficRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("globalaccelerator").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("globalaccelerator").close method. boto3 documentation

# close method definition

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

create_accelerator

Create an accelerator.

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

# create_accelerator method definition

def create_accelerator(
    self,
    *,
    Name: str,
    IdempotencyToken: str,
    IpAddressType: IpAddressTypeType = ...,  # (1)
    IpAddresses: Sequence[str] = ...,
    Enabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAcceleratorResponseTypeDef:  # (3)
    ...

1. See IpAddressTypeType
2. See TagTypeDef
3. See CreateAcceleratorResponseTypeDef

# create_accelerator method usage example with argument unpacking

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

parent.create_accelerator(**kwargs)

1. See CreateAcceleratorRequestRequestTypeDef

create_custom_routing_accelerator

Create a custom routing accelerator.

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

# create_custom_routing_accelerator method definition

def create_custom_routing_accelerator(
    self,
    *,
    Name: str,
    IdempotencyToken: str,
    IpAddressType: IpAddressTypeType = ...,  # (1)
    IpAddresses: Sequence[str] = ...,
    Enabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateCustomRoutingAcceleratorResponseTypeDef:  # (3)
    ...

1. See IpAddressTypeType
2. See TagTypeDef
3. See CreateCustomRoutingAcceleratorResponseTypeDef

# create_custom_routing_accelerator method usage example with argument unpacking

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

parent.create_custom_routing_accelerator(**kwargs)

1. See CreateCustomRoutingAcceleratorRequestRequestTypeDef

create_custom_routing_endpoint_group

Create an endpoint group for the specified listener for a custom routing accelerator.

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

# create_custom_routing_endpoint_group method definition

def create_custom_routing_endpoint_group(
    self,
    *,
    ListenerArn: str,
    EndpointGroupRegion: str,
    DestinationConfigurations: Sequence[CustomRoutingDestinationConfigurationTypeDef],  # (1)
    IdempotencyToken: str,
) -> CreateCustomRoutingEndpointGroupResponseTypeDef:  # (2)
    ...

1. See CustomRoutingDestinationConfigurationTypeDef
2. See CreateCustomRoutingEndpointGroupResponseTypeDef

# create_custom_routing_endpoint_group method usage example with argument unpacking

kwargs: CreateCustomRoutingEndpointGroupRequestRequestTypeDef = {  # (1)
    "ListenerArn": ...,
    "EndpointGroupRegion": ...,
    "DestinationConfigurations": ...,
    "IdempotencyToken": ...,
}

parent.create_custom_routing_endpoint_group(**kwargs)

1. See CreateCustomRoutingEndpointGroupRequestRequestTypeDef

create_custom_routing_listener

Create a listener to process inbound connections from clients to a custom routing accelerator.

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

# create_custom_routing_listener method definition

def create_custom_routing_listener(
    self,
    *,
    AcceleratorArn: str,
    PortRanges: Sequence[PortRangeTypeDef],  # (1)
    IdempotencyToken: str,
) -> CreateCustomRoutingListenerResponseTypeDef:  # (2)
    ...

1. See PortRangeTypeDef
2. See CreateCustomRoutingListenerResponseTypeDef

# create_custom_routing_listener method usage example with argument unpacking

kwargs: CreateCustomRoutingListenerRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
    "PortRanges": ...,
    "IdempotencyToken": ...,
}

parent.create_custom_routing_listener(**kwargs)

1. See CreateCustomRoutingListenerRequestRequestTypeDef

create_endpoint_group

Create an endpoint group for the specified listener.

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

# create_endpoint_group method definition

def create_endpoint_group(
    self,
    *,
    ListenerArn: str,
    EndpointGroupRegion: str,
    IdempotencyToken: str,
    EndpointConfigurations: Sequence[EndpointConfigurationTypeDef] = ...,  # (1)
    TrafficDialPercentage: float = ...,
    HealthCheckPort: int = ...,
    HealthCheckProtocol: HealthCheckProtocolType = ...,  # (2)
    HealthCheckPath: str = ...,
    HealthCheckIntervalSeconds: int = ...,
    ThresholdCount: int = ...,
    PortOverrides: Sequence[PortOverrideTypeDef] = ...,  # (3)
) -> CreateEndpointGroupResponseTypeDef:  # (4)
    ...

1. See EndpointConfigurationTypeDef
2. See HealthCheckProtocolType
3. See PortOverrideTypeDef
4. See CreateEndpointGroupResponseTypeDef

# create_endpoint_group method usage example with argument unpacking

kwargs: CreateEndpointGroupRequestRequestTypeDef = {  # (1)
    "ListenerArn": ...,
    "EndpointGroupRegion": ...,
    "IdempotencyToken": ...,
}

parent.create_endpoint_group(**kwargs)

1. See CreateEndpointGroupRequestRequestTypeDef

create_listener

Create a listener to process inbound connections from clients to an accelerator.

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

# create_listener method definition

def create_listener(
    self,
    *,
    AcceleratorArn: str,
    PortRanges: Sequence[PortRangeTypeDef],  # (1)
    Protocol: ProtocolType,  # (2)
    IdempotencyToken: str,
    ClientAffinity: ClientAffinityType = ...,  # (3)
) -> CreateListenerResponseTypeDef:  # (4)
    ...

1. See PortRangeTypeDef
2. See ProtocolType
3. See ClientAffinityType
4. See CreateListenerResponseTypeDef

# create_listener method usage example with argument unpacking

kwargs: CreateListenerRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
    "PortRanges": ...,
    "Protocol": ...,
    "IdempotencyToken": ...,
}

parent.create_listener(**kwargs)

1. See CreateListenerRequestRequestTypeDef

delete_accelerator

Delete an accelerator.

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

# delete_accelerator method definition

def delete_accelerator(
    self,
    *,
    AcceleratorArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_accelerator method usage example with argument unpacking

kwargs: DeleteAcceleratorRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.delete_accelerator(**kwargs)

1. See DeleteAcceleratorRequestRequestTypeDef

delete_custom_routing_accelerator

Delete a custom routing accelerator.

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

# delete_custom_routing_accelerator method definition

def delete_custom_routing_accelerator(
    self,
    *,
    AcceleratorArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_custom_routing_accelerator method usage example with argument unpacking

kwargs: DeleteCustomRoutingAcceleratorRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.delete_custom_routing_accelerator(**kwargs)

1. See DeleteCustomRoutingAcceleratorRequestRequestTypeDef

delete_custom_routing_endpoint_group

Delete an endpoint group from a listener for a custom routing accelerator.

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

# delete_custom_routing_endpoint_group method definition

def delete_custom_routing_endpoint_group(
    self,
    *,
    EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_custom_routing_endpoint_group method usage example with argument unpacking

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

parent.delete_custom_routing_endpoint_group(**kwargs)

1. See DeleteCustomRoutingEndpointGroupRequestRequestTypeDef

delete_custom_routing_listener

Delete a listener for a custom routing accelerator.

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

# delete_custom_routing_listener method definition

def delete_custom_routing_listener(
    self,
    *,
    ListenerArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_custom_routing_listener method usage example with argument unpacking

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

parent.delete_custom_routing_listener(**kwargs)

1. See DeleteCustomRoutingListenerRequestRequestTypeDef

delete_endpoint_group

Delete an endpoint group from a listener.

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

# delete_endpoint_group method definition

def delete_endpoint_group(
    self,
    *,
    EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_endpoint_group method usage example with argument unpacking

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

parent.delete_endpoint_group(**kwargs)

1. See DeleteEndpointGroupRequestRequestTypeDef

delete_listener

Delete a listener from an accelerator.

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

# delete_listener method definition

def delete_listener(
    self,
    *,
    ListenerArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_listener method usage example with argument unpacking

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

parent.delete_listener(**kwargs)

1. See DeleteListenerRequestRequestTypeDef

deny_custom_routing_traffic

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

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

# deny_custom_routing_traffic method definition

def deny_custom_routing_traffic(
    self,
    *,
    EndpointGroupArn: str,
    EndpointId: str,
    DestinationAddresses: Sequence[str] = ...,
    DestinationPorts: Sequence[int] = ...,
    DenyAllTrafficToEndpoint: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deny_custom_routing_traffic method usage example with argument unpacking

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

parent.deny_custom_routing_traffic(**kwargs)

1. See DenyCustomRoutingTrafficRequestRequestTypeDef

deprovision_byoip_cidr

Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

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

# deprovision_byoip_cidr method definition

def deprovision_byoip_cidr(
    self,
    *,
    Cidr: str,
) -> DeprovisionByoipCidrResponseTypeDef:  # (1)
    ...

1. See DeprovisionByoipCidrResponseTypeDef

# deprovision_byoip_cidr method usage example with argument unpacking

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

parent.deprovision_byoip_cidr(**kwargs)

1. See DeprovisionByoipCidrRequestRequestTypeDef

describe_accelerator

Describe an accelerator.

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

# describe_accelerator method definition

def describe_accelerator(
    self,
    *,
    AcceleratorArn: str,
) -> DescribeAcceleratorResponseTypeDef:  # (1)
    ...

1. See DescribeAcceleratorResponseTypeDef

# describe_accelerator method usage example with argument unpacking

kwargs: DescribeAcceleratorRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.describe_accelerator(**kwargs)

1. See DescribeAcceleratorRequestRequestTypeDef

describe_accelerator_attributes

Describe the attributes of an accelerator.

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

# describe_accelerator_attributes method definition

def describe_accelerator_attributes(
    self,
    *,
    AcceleratorArn: str,
) -> DescribeAcceleratorAttributesResponseTypeDef:  # (1)
    ...

1. See DescribeAcceleratorAttributesResponseTypeDef

# describe_accelerator_attributes method usage example with argument unpacking

kwargs: DescribeAcceleratorAttributesRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.describe_accelerator_attributes(**kwargs)

1. See DescribeAcceleratorAttributesRequestRequestTypeDef

describe_custom_routing_accelerator

Describe a custom routing accelerator.

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

# describe_custom_routing_accelerator method definition

def describe_custom_routing_accelerator(
    self,
    *,
    AcceleratorArn: str,
) -> DescribeCustomRoutingAcceleratorResponseTypeDef:  # (1)
    ...

1. See DescribeCustomRoutingAcceleratorResponseTypeDef

# describe_custom_routing_accelerator method usage example with argument unpacking

kwargs: DescribeCustomRoutingAcceleratorRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.describe_custom_routing_accelerator(**kwargs)

1. See DescribeCustomRoutingAcceleratorRequestRequestTypeDef

describe_custom_routing_accelerator_attributes

Describe the attributes of a custom routing accelerator.

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

# describe_custom_routing_accelerator_attributes method definition

def describe_custom_routing_accelerator_attributes(
    self,
    *,
    AcceleratorArn: str,
) -> DescribeCustomRoutingAcceleratorAttributesResponseTypeDef:  # (1)
    ...

1. See DescribeCustomRoutingAcceleratorAttributesResponseTypeDef

# describe_custom_routing_accelerator_attributes method usage example with argument unpacking

kwargs: DescribeCustomRoutingAcceleratorAttributesRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.describe_custom_routing_accelerator_attributes(**kwargs)

1. See DescribeCustomRoutingAcceleratorAttributesRequestRequestTypeDef

describe_custom_routing_endpoint_group

Describe an endpoint group for a custom routing accelerator.

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

# describe_custom_routing_endpoint_group method definition

def describe_custom_routing_endpoint_group(
    self,
    *,
    EndpointGroupArn: str,
) -> DescribeCustomRoutingEndpointGroupResponseTypeDef:  # (1)
    ...

1. See DescribeCustomRoutingEndpointGroupResponseTypeDef

# describe_custom_routing_endpoint_group method usage example with argument unpacking

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

parent.describe_custom_routing_endpoint_group(**kwargs)

1. See DescribeCustomRoutingEndpointGroupRequestRequestTypeDef

describe_custom_routing_listener

The description of a listener for a custom routing accelerator.

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

# describe_custom_routing_listener method definition

def describe_custom_routing_listener(
    self,
    *,
    ListenerArn: str,
) -> DescribeCustomRoutingListenerResponseTypeDef:  # (1)
    ...

1. See DescribeCustomRoutingListenerResponseTypeDef

# describe_custom_routing_listener method usage example with argument unpacking

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

parent.describe_custom_routing_listener(**kwargs)

1. See DescribeCustomRoutingListenerRequestRequestTypeDef

describe_endpoint_group

Describe an endpoint group.

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

# describe_endpoint_group method definition

def describe_endpoint_group(
    self,
    *,
    EndpointGroupArn: str,
) -> DescribeEndpointGroupResponseTypeDef:  # (1)
    ...

1. See DescribeEndpointGroupResponseTypeDef

# describe_endpoint_group method usage example with argument unpacking

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

parent.describe_endpoint_group(**kwargs)

1. See DescribeEndpointGroupRequestRequestTypeDef

describe_listener

Describe a listener.

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

# describe_listener method definition

def describe_listener(
    self,
    *,
    ListenerArn: str,
) -> DescribeListenerResponseTypeDef:  # (1)
    ...

1. See DescribeListenerResponseTypeDef

# describe_listener method usage example with argument unpacking

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

parent.describe_listener(**kwargs)

1. See DescribeListenerRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("globalaccelerator").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:
    ...

list_accelerators

List the accelerators for an Amazon Web Services account.

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

# list_accelerators method definition

def list_accelerators(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAcceleratorsResponseTypeDef:  # (1)
    ...

1. See ListAcceleratorsResponseTypeDef

# list_accelerators method usage example with argument unpacking

kwargs: ListAcceleratorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_accelerators(**kwargs)

1. See ListAcceleratorsRequestRequestTypeDef

list_byoip_cidrs

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr_, including the current state and a history of state changes.

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

# list_byoip_cidrs method definition

def list_byoip_cidrs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListByoipCidrsResponseTypeDef:  # (1)
    ...

1. See ListByoipCidrsResponseTypeDef

# list_byoip_cidrs method usage example with argument unpacking

kwargs: ListByoipCidrsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_byoip_cidrs(**kwargs)

1. See ListByoipCidrsRequestRequestTypeDef

list_custom_routing_accelerators

List the custom routing accelerators for an Amazon Web Services account.

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

# list_custom_routing_accelerators method definition

def list_custom_routing_accelerators(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCustomRoutingAcceleratorsResponseTypeDef:  # (1)
    ...

1. See ListCustomRoutingAcceleratorsResponseTypeDef

# list_custom_routing_accelerators method usage example with argument unpacking

kwargs: ListCustomRoutingAcceleratorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_custom_routing_accelerators(**kwargs)

1. See ListCustomRoutingAcceleratorsRequestRequestTypeDef

list_custom_routing_endpoint_groups

List the endpoint groups that are associated with a listener for a custom routing accelerator.

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

# list_custom_routing_endpoint_groups method definition

def list_custom_routing_endpoint_groups(
    self,
    *,
    ListenerArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCustomRoutingEndpointGroupsResponseTypeDef:  # (1)
    ...

1. See ListCustomRoutingEndpointGroupsResponseTypeDef

# list_custom_routing_endpoint_groups method usage example with argument unpacking

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

parent.list_custom_routing_endpoint_groups(**kwargs)

1. See ListCustomRoutingEndpointGroupsRequestRequestTypeDef

list_custom_routing_listeners

List the listeners for a custom routing accelerator.

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

# list_custom_routing_listeners method definition

def list_custom_routing_listeners(
    self,
    *,
    AcceleratorArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCustomRoutingListenersResponseTypeDef:  # (1)
    ...

1. See ListCustomRoutingListenersResponseTypeDef

# list_custom_routing_listeners method usage example with argument unpacking

kwargs: ListCustomRoutingListenersRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.list_custom_routing_listeners(**kwargs)

1. See ListCustomRoutingListenersRequestRequestTypeDef

list_custom_routing_port_mappings

Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.

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

# list_custom_routing_port_mappings method definition

def list_custom_routing_port_mappings(
    self,
    *,
    AcceleratorArn: str,
    EndpointGroupArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCustomRoutingPortMappingsResponseTypeDef:  # (1)
    ...

1. See ListCustomRoutingPortMappingsResponseTypeDef

# list_custom_routing_port_mappings method usage example with argument unpacking

kwargs: ListCustomRoutingPortMappingsRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.list_custom_routing_port_mappings(**kwargs)

1. See ListCustomRoutingPortMappingsRequestRequestTypeDef

list_custom_routing_port_mappings_by_destination

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.

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

# list_custom_routing_port_mappings_by_destination method definition

def list_custom_routing_port_mappings_by_destination(
    self,
    *,
    EndpointId: str,
    DestinationAddress: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCustomRoutingPortMappingsByDestinationResponseTypeDef:  # (1)
    ...

1. See ListCustomRoutingPortMappingsByDestinationResponseTypeDef

# list_custom_routing_port_mappings_by_destination method usage example with argument unpacking

kwargs: ListCustomRoutingPortMappingsByDestinationRequestRequestTypeDef = {  # (1)
    "EndpointId": ...,
    "DestinationAddress": ...,
}

parent.list_custom_routing_port_mappings_by_destination(**kwargs)

1. See ListCustomRoutingPortMappingsByDestinationRequestRequestTypeDef

list_endpoint_groups

List the endpoint groups that are associated with a listener.

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

# list_endpoint_groups method definition

def list_endpoint_groups(
    self,
    *,
    ListenerArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListEndpointGroupsResponseTypeDef:  # (1)
    ...

1. See ListEndpointGroupsResponseTypeDef

# list_endpoint_groups method usage example with argument unpacking

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

parent.list_endpoint_groups(**kwargs)

1. See ListEndpointGroupsRequestRequestTypeDef

list_listeners

List the listeners for an accelerator.

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

# list_listeners method definition

def list_listeners(
    self,
    *,
    AcceleratorArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListListenersResponseTypeDef:  # (1)
    ...

1. See ListListenersResponseTypeDef

# list_listeners method usage example with argument unpacking

kwargs: ListListenersRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.list_listeners(**kwargs)

1. See ListListenersRequestRequestTypeDef

list_tags_for_resource

List all tags for an accelerator.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

provision_byoip_cidr

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.

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

# provision_byoip_cidr method definition

def provision_byoip_cidr(
    self,
    *,
    Cidr: str,
    CidrAuthorizationContext: CidrAuthorizationContextTypeDef,  # (1)
) -> ProvisionByoipCidrResponseTypeDef:  # (2)
    ...

1. See CidrAuthorizationContextTypeDef
2. See ProvisionByoipCidrResponseTypeDef

# provision_byoip_cidr method usage example with argument unpacking

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

parent.provision_byoip_cidr(**kwargs)

1. See ProvisionByoipCidrRequestRequestTypeDef

remove_custom_routing_endpoints

Remove endpoints from a custom routing accelerator.

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

# remove_custom_routing_endpoints method definition

def remove_custom_routing_endpoints(
    self,
    *,
    EndpointIds: Sequence[str],
    EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# remove_custom_routing_endpoints method usage example with argument unpacking

kwargs: RemoveCustomRoutingEndpointsRequestRequestTypeDef = {  # (1)
    "EndpointIds": ...,
    "EndpointGroupArn": ...,
}

parent.remove_custom_routing_endpoints(**kwargs)

1. See RemoveCustomRoutingEndpointsRequestRequestTypeDef

remove_endpoints

Remove endpoints from an endpoint group.

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

# remove_endpoints method definition

def remove_endpoints(
    self,
    *,
    EndpointIdentifiers: Sequence[EndpointIdentifierTypeDef],  # (1)
    EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See EndpointIdentifierTypeDef
2. See EmptyResponseMetadataTypeDef

# remove_endpoints method usage example with argument unpacking

kwargs: RemoveEndpointsRequestRequestTypeDef = {  # (1)
    "EndpointIdentifiers": ...,
    "EndpointGroupArn": ...,
}

parent.remove_endpoints(**kwargs)

1. See RemoveEndpointsRequestRequestTypeDef

tag_resource

Add tags to an accelerator resource.

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

# tag_resource method definition

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

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Remove tags from a Global Accelerator resource.

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

# untag_resource method definition

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

# untag_resource method usage example with argument unpacking

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_accelerator

Update an accelerator.

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

# update_accelerator method definition

def update_accelerator(
    self,
    *,
    AcceleratorArn: str,
    Name: str = ...,
    IpAddressType: IpAddressTypeType = ...,  # (1)
    Enabled: bool = ...,
) -> UpdateAcceleratorResponseTypeDef:  # (2)
    ...

1. See IpAddressTypeType
2. See UpdateAcceleratorResponseTypeDef

# update_accelerator method usage example with argument unpacking

kwargs: UpdateAcceleratorRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.update_accelerator(**kwargs)

1. See UpdateAcceleratorRequestRequestTypeDef

update_accelerator_attributes

Update the attributes for an accelerator.

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

# update_accelerator_attributes method definition

def update_accelerator_attributes(
    self,
    *,
    AcceleratorArn: str,
    FlowLogsEnabled: bool = ...,
    FlowLogsS3Bucket: str = ...,
    FlowLogsS3Prefix: str = ...,
) -> UpdateAcceleratorAttributesResponseTypeDef:  # (1)
    ...

1. See UpdateAcceleratorAttributesResponseTypeDef

# update_accelerator_attributes method usage example with argument unpacking

kwargs: UpdateAcceleratorAttributesRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.update_accelerator_attributes(**kwargs)

1. See UpdateAcceleratorAttributesRequestRequestTypeDef

update_custom_routing_accelerator

Update a custom routing accelerator.

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

# update_custom_routing_accelerator method definition

def update_custom_routing_accelerator(
    self,
    *,
    AcceleratorArn: str,
    Name: str = ...,
    IpAddressType: IpAddressTypeType = ...,  # (1)
    Enabled: bool = ...,
) -> UpdateCustomRoutingAcceleratorResponseTypeDef:  # (2)
    ...

1. See IpAddressTypeType
2. See UpdateCustomRoutingAcceleratorResponseTypeDef

# update_custom_routing_accelerator method usage example with argument unpacking

kwargs: UpdateCustomRoutingAcceleratorRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.update_custom_routing_accelerator(**kwargs)

1. See UpdateCustomRoutingAcceleratorRequestRequestTypeDef

update_custom_routing_accelerator_attributes

Update the attributes for a custom routing accelerator.

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

# update_custom_routing_accelerator_attributes method definition

def update_custom_routing_accelerator_attributes(
    self,
    *,
    AcceleratorArn: str,
    FlowLogsEnabled: bool = ...,
    FlowLogsS3Bucket: str = ...,
    FlowLogsS3Prefix: str = ...,
) -> UpdateCustomRoutingAcceleratorAttributesResponseTypeDef:  # (1)
    ...

1. See UpdateCustomRoutingAcceleratorAttributesResponseTypeDef

# update_custom_routing_accelerator_attributes method usage example with argument unpacking

kwargs: UpdateCustomRoutingAcceleratorAttributesRequestRequestTypeDef = {  # (1)
    "AcceleratorArn": ...,
}

parent.update_custom_routing_accelerator_attributes(**kwargs)

1. See UpdateCustomRoutingAcceleratorAttributesRequestRequestTypeDef

update_custom_routing_listener

Update a listener for a custom routing accelerator.

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

# update_custom_routing_listener method definition

def update_custom_routing_listener(
    self,
    *,
    ListenerArn: str,
    PortRanges: Sequence[PortRangeTypeDef],  # (1)
) -> UpdateCustomRoutingListenerResponseTypeDef:  # (2)
    ...

1. See PortRangeTypeDef
2. See UpdateCustomRoutingListenerResponseTypeDef

# update_custom_routing_listener method usage example with argument unpacking

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

parent.update_custom_routing_listener(**kwargs)

1. See UpdateCustomRoutingListenerRequestRequestTypeDef

update_endpoint_group

Update an endpoint group.

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

# update_endpoint_group method definition

def update_endpoint_group(
    self,
    *,
    EndpointGroupArn: str,
    EndpointConfigurations: Sequence[EndpointConfigurationTypeDef] = ...,  # (1)
    TrafficDialPercentage: float = ...,
    HealthCheckPort: int = ...,
    HealthCheckProtocol: HealthCheckProtocolType = ...,  # (2)
    HealthCheckPath: str = ...,
    HealthCheckIntervalSeconds: int = ...,
    ThresholdCount: int = ...,
    PortOverrides: Sequence[PortOverrideTypeDef] = ...,  # (3)
) -> UpdateEndpointGroupResponseTypeDef:  # (4)
    ...

1. See EndpointConfigurationTypeDef
2. See HealthCheckProtocolType
3. See PortOverrideTypeDef
4. See UpdateEndpointGroupResponseTypeDef

# update_endpoint_group method usage example with argument unpacking

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

parent.update_endpoint_group(**kwargs)

1. See UpdateEndpointGroupRequestRequestTypeDef

update_listener

Update a listener.

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

# update_listener method definition

def update_listener(
    self,
    *,
    ListenerArn: str,
    PortRanges: Sequence[PortRangeTypeDef] = ...,  # (1)
    Protocol: ProtocolType = ...,  # (2)
    ClientAffinity: ClientAffinityType = ...,  # (3)
) -> UpdateListenerResponseTypeDef:  # (4)
    ...

1. See PortRangeTypeDef
2. See ProtocolType
3. See ClientAffinityType
4. See UpdateListenerResponseTypeDef

# update_listener method usage example with argument unpacking

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

parent.update_listener(**kwargs)

1. See UpdateListenerRequestRequestTypeDef

withdraw_byoip_cidr

Stops advertising an address range that is provisioned as an address pool.

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

# withdraw_byoip_cidr method definition

def withdraw_byoip_cidr(
    self,
    *,
    Cidr: str,
) -> WithdrawByoipCidrResponseTypeDef:  # (1)
    ...

1. See WithdrawByoipCidrResponseTypeDef

# withdraw_byoip_cidr method usage example with argument unpacking

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

parent.withdraw_byoip_cidr(**kwargs)

1. See WithdrawByoipCidrRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_accelerators") -> ListAcceleratorsPaginator
• client.get_paginator("list_byoip_cidrs") -> ListByoipCidrsPaginator
• client.get_paginator("list_custom_routing_accelerators") -> ListCustomRoutingAcceleratorsPaginator
• client.get_paginator("list_custom_routing_listeners") -> ListCustomRoutingListenersPaginator
• client.get_paginator("list_custom_routing_port_mappings") -> ListCustomRoutingPortMappingsPaginator
• client.get_paginator("list_custom_routing_port_mappings_by_destination") -> ListCustomRoutingPortMappingsByDestinationPaginator
• client.get_paginator("list_endpoint_groups") -> ListEndpointGroupsPaginator
• client.get_paginator("list_listeners") -> ListListenersPaginator