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
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.
client = boto3.client("globalaccelerator")
try:
do_something(client)
except (
client.AcceleratorNotDisabledException,
client.AcceleratorNotFoundException,
client.AccessDeniedException,
client.AssociatedEndpointGroupFoundException,
client.AssociatedListenerFoundException,
client.ByoipCidrNotFoundException,
client.ClientError,
client.ConflictException,
client.EndpointAlreadyExistsException,
client.EndpointGroupAlreadyExistsException,
client.EndpointGroupNotFoundException,
client.EndpointNotFoundException,
client.IncorrectCidrStateException,
client.InternalServiceErrorException,
client.InvalidArgumentException,
client.InvalidNextTokenException,
client.InvalidPortRangeException,
client.LimitExceededException,
client.ListenerNotFoundException,
client.TransactionInProgressException,
) as e:
print(e)
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
def add_custom_routing_endpoints(
self,
*,
EndpointConfigurations: Sequence[CustomRoutingEndpointConfigurationTypeDef], # (1)
EndpointGroupArn: str,
) -> AddCustomRoutingEndpointsResponseTypeDef: # (2)
...
kwargs: AddCustomRoutingEndpointsRequestRequestTypeDef = { # (1)
"EndpointConfigurations": ...,
"EndpointGroupArn": ...,
}
parent.add_custom_routing_endpoints(**kwargs)
add_endpoints
Add endpoints to an endpoint group.
Type annotations and code completion for boto3.client("globalaccelerator").add_endpoints
method.
boto3 documentation
def add_endpoints(
self,
*,
EndpointConfigurations: Sequence[EndpointConfigurationTypeDef], # (1)
EndpointGroupArn: str,
) -> AddEndpointsResponseTypeDef: # (2)
...
kwargs: AddEndpointsRequestRequestTypeDef = { # (1)
"EndpointConfigurations": ...,
"EndpointGroupArn": ...,
}
parent.add_endpoints(**kwargs)
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
def advertise_byoip_cidr(
self,
*,
Cidr: str,
) -> AdvertiseByoipCidrResponseTypeDef: # (1)
...
kwargs: AdvertiseByoipCidrRequestRequestTypeDef = { # (1)
"Cidr": ...,
}
parent.advertise_byoip_cidr(**kwargs)
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
def allow_custom_routing_traffic(
self,
*,
EndpointGroupArn: str,
EndpointId: str,
DestinationAddresses: Sequence[str] = ...,
DestinationPorts: Sequence[int] = ...,
AllowAllTrafficToEndpoint: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AllowCustomRoutingTrafficRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
"EndpointId": ...,
}
parent.allow_custom_routing_traffic(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("globalaccelerator").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("globalaccelerator").close
method.
boto3 documentation
create_accelerator
Create an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").create_accelerator
method.
boto3 documentation
def create_accelerator(
self,
*,
Name: str,
IdempotencyToken: str,
IpAddressType: IpAddressTypeType = ..., # (1)
IpAddresses: Sequence[str] = ...,
Enabled: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateAcceleratorResponseTypeDef: # (3)
...
kwargs: CreateAcceleratorRequestRequestTypeDef = { # (1)
"Name": ...,
"IdempotencyToken": ...,
}
parent.create_accelerator(**kwargs)
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
def create_custom_routing_accelerator(
self,
*,
Name: str,
IdempotencyToken: str,
IpAddressType: IpAddressTypeType = ..., # (1)
IpAddresses: Sequence[str] = ...,
Enabled: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateCustomRoutingAcceleratorResponseTypeDef: # (3)
...
kwargs: CreateCustomRoutingAcceleratorRequestRequestTypeDef = { # (1)
"Name": ...,
"IdempotencyToken": ...,
}
parent.create_custom_routing_accelerator(**kwargs)
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
def create_custom_routing_endpoint_group(
self,
*,
ListenerArn: str,
EndpointGroupRegion: str,
DestinationConfigurations: Sequence[CustomRoutingDestinationConfigurationTypeDef], # (1)
IdempotencyToken: str,
) -> CreateCustomRoutingEndpointGroupResponseTypeDef: # (2)
...
- See CustomRoutingDestinationConfigurationTypeDef
- See CreateCustomRoutingEndpointGroupResponseTypeDef
kwargs: CreateCustomRoutingEndpointGroupRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
"EndpointGroupRegion": ...,
"DestinationConfigurations": ...,
"IdempotencyToken": ...,
}
parent.create_custom_routing_endpoint_group(**kwargs)
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
def create_custom_routing_listener(
self,
*,
AcceleratorArn: str,
PortRanges: Sequence[PortRangeTypeDef], # (1)
IdempotencyToken: str,
) -> CreateCustomRoutingListenerResponseTypeDef: # (2)
...
kwargs: CreateCustomRoutingListenerRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
"PortRanges": ...,
"IdempotencyToken": ...,
}
parent.create_custom_routing_listener(**kwargs)
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
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)
...
- See EndpointConfigurationTypeDef
- See HealthCheckProtocolType
- See PortOverrideTypeDef
- See CreateEndpointGroupResponseTypeDef
kwargs: CreateEndpointGroupRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
"EndpointGroupRegion": ...,
"IdempotencyToken": ...,
}
parent.create_endpoint_group(**kwargs)
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
def create_listener(
self,
*,
AcceleratorArn: str,
PortRanges: Sequence[PortRangeTypeDef], # (1)
Protocol: ProtocolType, # (2)
IdempotencyToken: str,
ClientAffinity: ClientAffinityType = ..., # (3)
) -> CreateListenerResponseTypeDef: # (4)
...
- See PortRangeTypeDef
- See ProtocolType
- See ClientAffinityType
- See CreateListenerResponseTypeDef
kwargs: CreateListenerRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
"PortRanges": ...,
"Protocol": ...,
"IdempotencyToken": ...,
}
parent.create_listener(**kwargs)
delete_accelerator
Delete an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").delete_accelerator
method.
boto3 documentation
def delete_accelerator(
self,
*,
AcceleratorArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAcceleratorRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.delete_accelerator(**kwargs)
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
def delete_custom_routing_accelerator(
self,
*,
AcceleratorArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCustomRoutingAcceleratorRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.delete_custom_routing_accelerator(**kwargs)
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
def delete_custom_routing_endpoint_group(
self,
*,
EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCustomRoutingEndpointGroupRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
}
parent.delete_custom_routing_endpoint_group(**kwargs)
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
def delete_custom_routing_listener(
self,
*,
ListenerArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCustomRoutingListenerRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.delete_custom_routing_listener(**kwargs)
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
def delete_endpoint_group(
self,
*,
EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteEndpointGroupRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
}
parent.delete_endpoint_group(**kwargs)
delete_listener
Delete a listener from an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").delete_listener
method.
boto3 documentation
def delete_listener(
self,
*,
ListenerArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteListenerRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.delete_listener(**kwargs)
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
def deny_custom_routing_traffic(
self,
*,
EndpointGroupArn: str,
EndpointId: str,
DestinationAddresses: Sequence[str] = ...,
DestinationPorts: Sequence[int] = ...,
DenyAllTrafficToEndpoint: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DenyCustomRoutingTrafficRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
"EndpointId": ...,
}
parent.deny_custom_routing_traffic(**kwargs)
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
def deprovision_byoip_cidr(
self,
*,
Cidr: str,
) -> DeprovisionByoipCidrResponseTypeDef: # (1)
...
kwargs: DeprovisionByoipCidrRequestRequestTypeDef = { # (1)
"Cidr": ...,
}
parent.deprovision_byoip_cidr(**kwargs)
describe_accelerator
Describe an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").describe_accelerator
method.
boto3 documentation
def describe_accelerator(
self,
*,
AcceleratorArn: str,
) -> DescribeAcceleratorResponseTypeDef: # (1)
...
kwargs: DescribeAcceleratorRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.describe_accelerator(**kwargs)
describe_accelerator_attributes
Describe the attributes of an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").describe_accelerator_attributes
method.
boto3 documentation
def describe_accelerator_attributes(
self,
*,
AcceleratorArn: str,
) -> DescribeAcceleratorAttributesResponseTypeDef: # (1)
...
kwargs: DescribeAcceleratorAttributesRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.describe_accelerator_attributes(**kwargs)
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
def describe_custom_routing_accelerator(
self,
*,
AcceleratorArn: str,
) -> DescribeCustomRoutingAcceleratorResponseTypeDef: # (1)
...
kwargs: DescribeCustomRoutingAcceleratorRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.describe_custom_routing_accelerator(**kwargs)
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
def describe_custom_routing_accelerator_attributes(
self,
*,
AcceleratorArn: str,
) -> DescribeCustomRoutingAcceleratorAttributesResponseTypeDef: # (1)
...
kwargs: DescribeCustomRoutingAcceleratorAttributesRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.describe_custom_routing_accelerator_attributes(**kwargs)
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
def describe_custom_routing_endpoint_group(
self,
*,
EndpointGroupArn: str,
) -> DescribeCustomRoutingEndpointGroupResponseTypeDef: # (1)
...
kwargs: DescribeCustomRoutingEndpointGroupRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
}
parent.describe_custom_routing_endpoint_group(**kwargs)
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
def describe_custom_routing_listener(
self,
*,
ListenerArn: str,
) -> DescribeCustomRoutingListenerResponseTypeDef: # (1)
...
kwargs: DescribeCustomRoutingListenerRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.describe_custom_routing_listener(**kwargs)
describe_endpoint_group
Describe an endpoint group.
Type annotations and code completion for boto3.client("globalaccelerator").describe_endpoint_group
method.
boto3 documentation
def describe_endpoint_group(
self,
*,
EndpointGroupArn: str,
) -> DescribeEndpointGroupResponseTypeDef: # (1)
...
kwargs: DescribeEndpointGroupRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
}
parent.describe_endpoint_group(**kwargs)
describe_listener
Describe a listener.
Type annotations and code completion for boto3.client("globalaccelerator").describe_listener
method.
boto3 documentation
def describe_listener(
self,
*,
ListenerArn: str,
) -> DescribeListenerResponseTypeDef: # (1)
...
kwargs: DescribeListenerRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.describe_listener(**kwargs)
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
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
def list_accelerators(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAcceleratorsResponseTypeDef: # (1)
...
kwargs: ListAcceleratorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_accelerators(**kwargs)
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
def list_byoip_cidrs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListByoipCidrsResponseTypeDef: # (1)
...
kwargs: ListByoipCidrsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_byoip_cidrs(**kwargs)
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
def list_custom_routing_accelerators(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCustomRoutingAcceleratorsResponseTypeDef: # (1)
...
kwargs: ListCustomRoutingAcceleratorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_custom_routing_accelerators(**kwargs)
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
def list_custom_routing_endpoint_groups(
self,
*,
ListenerArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCustomRoutingEndpointGroupsResponseTypeDef: # (1)
...
kwargs: ListCustomRoutingEndpointGroupsRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.list_custom_routing_endpoint_groups(**kwargs)
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
def list_custom_routing_listeners(
self,
*,
AcceleratorArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCustomRoutingListenersResponseTypeDef: # (1)
...
kwargs: ListCustomRoutingListenersRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.list_custom_routing_listeners(**kwargs)
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
def list_custom_routing_port_mappings(
self,
*,
AcceleratorArn: str,
EndpointGroupArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCustomRoutingPortMappingsResponseTypeDef: # (1)
...
kwargs: ListCustomRoutingPortMappingsRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.list_custom_routing_port_mappings(**kwargs)
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
def list_custom_routing_port_mappings_by_destination(
self,
*,
EndpointId: str,
DestinationAddress: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCustomRoutingPortMappingsByDestinationResponseTypeDef: # (1)
...
kwargs: ListCustomRoutingPortMappingsByDestinationRequestRequestTypeDef = { # (1)
"EndpointId": ...,
"DestinationAddress": ...,
}
parent.list_custom_routing_port_mappings_by_destination(**kwargs)
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
def list_endpoint_groups(
self,
*,
ListenerArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListEndpointGroupsResponseTypeDef: # (1)
...
kwargs: ListEndpointGroupsRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.list_endpoint_groups(**kwargs)
list_listeners
List the listeners for an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").list_listeners
method.
boto3 documentation
def list_listeners(
self,
*,
AcceleratorArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListListenersResponseTypeDef: # (1)
...
kwargs: ListListenersRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.list_listeners(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def provision_byoip_cidr(
self,
*,
Cidr: str,
CidrAuthorizationContext: CidrAuthorizationContextTypeDef, # (1)
) -> ProvisionByoipCidrResponseTypeDef: # (2)
...
kwargs: ProvisionByoipCidrRequestRequestTypeDef = { # (1)
"Cidr": ...,
"CidrAuthorizationContext": ...,
}
parent.provision_byoip_cidr(**kwargs)
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
def remove_custom_routing_endpoints(
self,
*,
EndpointIds: Sequence[str],
EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RemoveCustomRoutingEndpointsRequestRequestTypeDef = { # (1)
"EndpointIds": ...,
"EndpointGroupArn": ...,
}
parent.remove_custom_routing_endpoints(**kwargs)
remove_endpoints
Remove endpoints from an endpoint group.
Type annotations and code completion for boto3.client("globalaccelerator").remove_endpoints
method.
boto3 documentation
def remove_endpoints(
self,
*,
EndpointIdentifiers: Sequence[EndpointIdentifierTypeDef], # (1)
EndpointGroupArn: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: RemoveEndpointsRequestRequestTypeDef = { # (1)
"EndpointIdentifiers": ...,
"EndpointGroupArn": ...,
}
parent.remove_endpoints(**kwargs)
tag_resource
Add tags to an accelerator resource.
Type annotations and code completion for boto3.client("globalaccelerator").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Remove tags from a Global Accelerator resource.
Type annotations and code completion for boto3.client("globalaccelerator").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_accelerator
Update an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").update_accelerator
method.
boto3 documentation
def update_accelerator(
self,
*,
AcceleratorArn: str,
Name: str = ...,
IpAddressType: IpAddressTypeType = ..., # (1)
Enabled: bool = ...,
) -> UpdateAcceleratorResponseTypeDef: # (2)
...
kwargs: UpdateAcceleratorRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.update_accelerator(**kwargs)
update_accelerator_attributes
Update the attributes for an accelerator.
Type annotations and code completion for boto3.client("globalaccelerator").update_accelerator_attributes
method.
boto3 documentation
def update_accelerator_attributes(
self,
*,
AcceleratorArn: str,
FlowLogsEnabled: bool = ...,
FlowLogsS3Bucket: str = ...,
FlowLogsS3Prefix: str = ...,
) -> UpdateAcceleratorAttributesResponseTypeDef: # (1)
...
kwargs: UpdateAcceleratorAttributesRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.update_accelerator_attributes(**kwargs)
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
def update_custom_routing_accelerator(
self,
*,
AcceleratorArn: str,
Name: str = ...,
IpAddressType: IpAddressTypeType = ..., # (1)
Enabled: bool = ...,
) -> UpdateCustomRoutingAcceleratorResponseTypeDef: # (2)
...
kwargs: UpdateCustomRoutingAcceleratorRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.update_custom_routing_accelerator(**kwargs)
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
def update_custom_routing_accelerator_attributes(
self,
*,
AcceleratorArn: str,
FlowLogsEnabled: bool = ...,
FlowLogsS3Bucket: str = ...,
FlowLogsS3Prefix: str = ...,
) -> UpdateCustomRoutingAcceleratorAttributesResponseTypeDef: # (1)
...
kwargs: UpdateCustomRoutingAcceleratorAttributesRequestRequestTypeDef = { # (1)
"AcceleratorArn": ...,
}
parent.update_custom_routing_accelerator_attributes(**kwargs)
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
def update_custom_routing_listener(
self,
*,
ListenerArn: str,
PortRanges: Sequence[PortRangeTypeDef], # (1)
) -> UpdateCustomRoutingListenerResponseTypeDef: # (2)
...
kwargs: UpdateCustomRoutingListenerRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
"PortRanges": ...,
}
parent.update_custom_routing_listener(**kwargs)
update_endpoint_group
Update an endpoint group.
Type annotations and code completion for boto3.client("globalaccelerator").update_endpoint_group
method.
boto3 documentation
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)
...
- See EndpointConfigurationTypeDef
- See HealthCheckProtocolType
- See PortOverrideTypeDef
- See UpdateEndpointGroupResponseTypeDef
kwargs: UpdateEndpointGroupRequestRequestTypeDef = { # (1)
"EndpointGroupArn": ...,
}
parent.update_endpoint_group(**kwargs)
update_listener
Update a listener.
Type annotations and code completion for boto3.client("globalaccelerator").update_listener
method.
boto3 documentation
def update_listener(
self,
*,
ListenerArn: str,
PortRanges: Sequence[PortRangeTypeDef] = ..., # (1)
Protocol: ProtocolType = ..., # (2)
ClientAffinity: ClientAffinityType = ..., # (3)
) -> UpdateListenerResponseTypeDef: # (4)
...
- See PortRangeTypeDef
- See ProtocolType
- See ClientAffinityType
- See UpdateListenerResponseTypeDef
kwargs: UpdateListenerRequestRequestTypeDef = { # (1)
"ListenerArn": ...,
}
parent.update_listener(**kwargs)
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
def withdraw_byoip_cidr(
self,
*,
Cidr: str,
) -> WithdrawByoipCidrResponseTypeDef: # (1)
...
kwargs: WithdrawByoipCidrRequestRequestTypeDef = { # (1)
"Cidr": ...,
}
parent.withdraw_byoip_cidr(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("globalaccelerator").get_paginator
method with overloads.
client.get_paginator("list_accelerators")
-> ListAcceleratorsPaginatorclient.get_paginator("list_byoip_cidrs")
-> ListByoipCidrsPaginatorclient.get_paginator("list_custom_routing_accelerators")
-> ListCustomRoutingAcceleratorsPaginatorclient.get_paginator("list_custom_routing_listeners")
-> ListCustomRoutingListenersPaginatorclient.get_paginator("list_custom_routing_port_mappings")
-> ListCustomRoutingPortMappingsPaginatorclient.get_paginator("list_custom_routing_port_mappings_by_destination")
-> ListCustomRoutingPortMappingsByDestinationPaginatorclient.get_paginator("list_endpoint_groups")
-> ListEndpointGroupsPaginatorclient.get_paginator("list_listeners")
-> ListListenersPaginator