Expand description
This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.
AWS Global Accelerator is a service in which you create accelerators to improve availability and performance of your applications for local and global users.
You must specify the US West (Oregon) Region to create or update accelerators.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. (Instead of using the IP addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator.) The static IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Network Load Balancers, Application Load Balancers, EC2 instances, or Elastic IP addresses that are located in one AWS Region or multiple Regions.
Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.
Global Accelerator includes components that work together to help you improve performance and availability for your applications:
- Static IP address
-
By default, AWS Global Accelerator provides you with a set of static IP addresses that are anycast from the AWS edge network and serve as the single fixed entry points for your clients. Or you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide. If you already have load balancers, EC2 instances, or Elastic IP addresses set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by the static IP addresses.
The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Authentication and Access Control in the AWS Global Accelerator Developer Guide.
- Accelerator
-
An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.
- DNS name
-
Global Accelerator assigns each accelerator a default Domain Name System (DNS) name, similar to
a1234567890abcdef.awsglobalaccelerator.com, that points to your Global Accelerator static IP addresses. Depending on the use case, you can use your accelerator's static IP addresses or DNS name to route traffic to your accelerator, or set up DNS records to route traffic using your own custom domain name. - Network zone
-
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, by default, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.
- Listener
-
A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.
- Endpoint group
-
Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example.
- Endpoint
-
An endpoint is a Network Load Balancer, Application Load Balancer, EC2 instance, or Elastic IP address. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.
If you’re using the service, you’re probably looking for GlobalAcceleratorClient and GlobalAccelerator.
Structs§
- Accelerator
An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.
- Accelerator
Attributes Attributes of an accelerator.
- Advertise
Byoip Cidr Request - Advertise
Byoip Cidr Response - Byoip
Cidr Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).
The following describes each BYOIP
Statethat your IP address range can be in.-
PENDINGPROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
-
READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
-
PENDINGADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
-
ADVERTISING — The address range is being advertised by AWS Global Accelerator.
-
PENDINGWITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
-
PENDINGDEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
-
DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
-
FAILEDPROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
-
FAILEDADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
-
FAILEDWITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
-
FAILEDDEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
-
- Byoip
Cidr Event A complex type that contains a
Messageand aTimestampvalue for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).- Cidr
Authorization Context Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP).
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
- Create
Accelerator Request - Create
Accelerator Response - Create
Endpoint Group Request - Create
Endpoint Group Response - Create
Listener Request - Create
Listener Response - Delete
Accelerator Request - Delete
Endpoint Group Request - Delete
Listener Request - Deprovision
Byoip Cidr Request - Deprovision
Byoip Cidr Response - Describe
Accelerator Attributes Request - Describe
Accelerator Attributes Response - Describe
Accelerator Request - Describe
Accelerator Response - Describe
Endpoint Group Request - Describe
Endpoint Group Response - Describe
Listener Request - Describe
Listener Response - Endpoint
Configuration A complex type for endpoints.
- Endpoint
Description A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
- Endpoint
Group A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.
- Global
Accelerator Client - A client for the AWS Global Accelerator API.
- IpSet
A complex type for the set of IP addresses for an accelerator.
- List
Accelerators Request - List
Accelerators Response - List
Byoip Cidrs Request - List
Byoip Cidrs Response - List
Endpoint Groups Request - List
Endpoint Groups Response - List
Listeners Request - List
Listeners Response - List
Tags ForResource Request - List
Tags ForResource Response - Listener
A complex type for a listener.
- Port
Range A complex type for a range of ports for a listener.
- Provision
Byoip Cidr Request - Provision
Byoip Cidr Response - Tag
A complex type that contains a
Tagkey andTagvalue.- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Update
Accelerator Attributes Request - Update
Accelerator Attributes Response - Update
Accelerator Request - Update
Accelerator Response - Update
Endpoint Group Request - Update
Endpoint Group Response - Update
Listener Request - Update
Listener Response - Withdraw
Byoip Cidr Request - Withdraw
Byoip Cidr Response
Enums§
- Advertise
Byoip Cidr Error - Errors returned by AdvertiseByoipCidr
- Create
Accelerator Error - Errors returned by CreateAccelerator
- Create
Endpoint Group Error - Errors returned by CreateEndpointGroup
- Create
Listener Error - Errors returned by CreateListener
- Delete
Accelerator Error - Errors returned by DeleteAccelerator
- Delete
Endpoint Group Error - Errors returned by DeleteEndpointGroup
- Delete
Listener Error - Errors returned by DeleteListener
- Deprovision
Byoip Cidr Error - Errors returned by DeprovisionByoipCidr
- Describe
Accelerator Attributes Error - Errors returned by DescribeAcceleratorAttributes
- Describe
Accelerator Error - Errors returned by DescribeAccelerator
- Describe
Endpoint Group Error - Errors returned by DescribeEndpointGroup
- Describe
Listener Error - Errors returned by DescribeListener
- List
Accelerators Error - Errors returned by ListAccelerators
- List
Byoip Cidrs Error - Errors returned by ListByoipCidrs
- List
Endpoint Groups Error - Errors returned by ListEndpointGroups
- List
Listeners Error - Errors returned by ListListeners
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Provision
Byoip Cidr Error - Errors returned by ProvisionByoipCidr
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Accelerator Attributes Error - Errors returned by UpdateAcceleratorAttributes
- Update
Accelerator Error - Errors returned by UpdateAccelerator
- Update
Endpoint Group Error - Errors returned by UpdateEndpointGroup
- Update
Listener Error - Errors returned by UpdateListener
- Withdraw
Byoip Cidr Error - Errors returned by WithdrawByoipCidr
Traits§
- Global
Accelerator - Trait representing the capabilities of the AWS Global Accelerator API. AWS Global Accelerator clients implement this trait.