AWS Global Accelerator
Global Accelerator This is the Global Accelerator API Reference . This guide is for developers who need detailed information about Global Accelerator API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Global Accelerator
This is the Global Accelerator API Reference . This guide is for developers who need detailed information about
Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
Global Accelerator Developer Guide .
Global Accelerator is a service in which you create accelerators to improve the performance
of your applications for local and global users. Depending on the type of accelerator you choose, you can
gain additional benefits.
By using a standard accelerator, you can improve availability of your internet applications
that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
global network.
For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you
can use application logic to directly map one or more users to a specific endpoint among many endpoints.
Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2
on Amazon Web Services CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
With a standard accelerator for IPv4, instead of using the 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 (BYOIP).
For a standard accelerator,
they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
are virtual private cloud (VPC) subnets.
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 like tag-based permissions with Global Accelerator to limit the users who have
permissions to delete an accelerator. For more information, see Tag-based policies .
For standard accelerators, Global Accelerator uses the Amazon Web Services 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 always
directed to healthy endpoints.
For more information about understanding and using Global Accelerator, see the
Global Accelerator Developer Guide .
Endpoints 56
- POSTAdd custom routing endpoints
/#X-Amz-Target=GlobalAccelerator_V20180706.AddCustomRoutingEndpointsAssociate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator. The listener port range must be large enough to support the… - POSTAdd endpoints
/#X-Amz-Target=GlobalAccelerator_V20180706.AddEndpointsAdd endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add… - POSTAdvertise byoip cidr
/#X-Amz-Target=GlobalAccelerator_V20180706.AdvertiseByoipCidrAdvertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take… - POSTAllow custom routing traffic
/#X-Amz-Target=GlobalAccelerator_V20180706.AllowCustomRoutingTrafficSpecify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You… - POSTCreate accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateAcceleratorCreate an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each… - POSTCreate cross account attachment
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateCrossAccountAttachmentCreate a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with… - POSTCreate custom routing accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingAcceleratorCreate a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in… - POSTCreate custom routing endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingEndpointGroupCreate an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web… - POSTCreate custom routing listener
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateCustomRoutingListenerCreate a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port… - POSTCreate endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateEndpointGroupCreate an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be… - POSTCreate listener
/#X-Amz-Target=GlobalAccelerator_V20180706.CreateListenerCreate a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or… - POSTDelete accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteAcceleratorDelete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To… - POSTDelete cross account attachment
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCrossAccountAttachmentDelete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all… - POSTDelete custom routing accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCustomRoutingAcceleratorDelete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint… - POSTDelete custom routing endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCustomRoutingEndpointGroupDelete an endpoint group from a listener for a custom routing accelerator. - POSTDelete custom routing listener
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteCustomRoutingListenerDelete a listener for a custom routing accelerator. - POSTDelete endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteEndpointGroupDelete an endpoint group from a listener. - POSTDelete listener
/#X-Amz-Target=GlobalAccelerator_V20180706.DeleteListenerDelete a listener from an accelerator. - POSTDeny custom routing traffic
/#X-Amz-Target=GlobalAccelerator_V20180706.DenyCustomRoutingTrafficSpecify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator.… - POSTDeprovision byoip cidr
/#X-Amz-Target=GlobalAccelerator_V20180706.DeprovisionByoipCidrReleases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and… - POSTDescribe accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeAcceleratorDescribe an accelerator. - POSTDescribe accelerator attributes
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeAcceleratorAttributesDescribe the attributes of an accelerator. - POSTDescribe cross account attachment
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCrossAccountAttachmentGets configuration information about a cross-account attachment. - POSTDescribe custom routing accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingAcceleratorDescribe a custom routing accelerator. - POSTDescribe custom routing accelerator attributes
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingAcceleratorAttributesDescribe the attributes of a custom routing accelerator. - POSTDescribe custom routing endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingEndpointGroupDescribe an endpoint group for a custom routing accelerator. - POSTDescribe custom routing listener
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingListenerThe description of a listener for a custom routing accelerator. - POSTDescribe endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeEndpointGroupDescribe an endpoint group. - POSTDescribe listener
/#X-Amz-Target=GlobalAccelerator_V20180706.DescribeListenerDescribe a listener. - POSTList accelerators
/#X-Amz-Target=GlobalAccelerator_V20180706.ListAcceleratorsList the accelerators for an Amazon Web Services account. - POSTList byoip cidrs
/#X-Amz-Target=GlobalAccelerator_V20180706.ListByoipCidrsLists the IP address ranges that were specified in calls to ProvisionByoipCidr , including the current state and a history of state changes. - POSTList cross account attachments
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCrossAccountAttachmentsList the cross-account attachments that have been created in Global Accelerator. - POSTList cross account resource accounts
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCrossAccountResourceAccountsList the accounts that have cross-account resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in… - POSTList cross account resources
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCrossAccountResourcesList the cross-account resources available to work with. - POSTList custom routing accelerators
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingAcceleratorsList the custom routing accelerators for an Amazon Web Services account. - POSTList custom routing endpoint groups
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingEndpointGroupsList the endpoint groups that are associated with a listener for a custom routing accelerator. - POSTList custom routing listeners
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingListenersList the listeners for a custom routing accelerator. - POSTList custom routing port mappings
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappingsProvides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud… - POSTList custom routing port mappings by destination
/#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappingsByDestinationList the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This… - POSTList endpoint groups
/#X-Amz-Target=GlobalAccelerator_V20180706.ListEndpointGroupsList the endpoint groups that are associated with a listener. - POSTList listeners
/#X-Amz-Target=GlobalAccelerator_V20180706.ListListenersList the listeners for an accelerator. - POSTList tags for resource
/#X-Amz-Target=GlobalAccelerator_V20180706.ListTagsForResourceList all tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide . - POSTProvision byoip cidr
/#X-Amz-Target=GlobalAccelerator_V20180706.ProvisionByoipCidrProvisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address… - POSTRemove custom routing endpoints
/#X-Amz-Target=GlobalAccelerator_V20180706.RemoveCustomRoutingEndpointsRemove endpoints from a custom routing accelerator. - POSTRemove endpoints
/#X-Amz-Target=GlobalAccelerator_V20180706.RemoveEndpointsRemove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove… - POSTTag resource
/#X-Amz-Target=GlobalAccelerator_V20180706.TagResourceAdd tags to an accelerator resource. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide . - POSTUntag resource
/#X-Amz-Target=GlobalAccelerator_V20180706.UntagResourceRemove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds… - POSTUpdate accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateAcceleratorUpdate an accelerator to make changes, such as the following: Change the name of the accelerator. Disable the accelerator so that it no longer accepts or… - POSTUpdate accelerator attributes
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateAcceleratorAttributesUpdate the attributes for an accelerator. - POSTUpdate cross account attachment
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCrossAccountAttachmentUpdate a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or… - POSTUpdate custom routing accelerator
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCustomRoutingAcceleratorUpdate a custom routing accelerator. - POSTUpdate custom routing accelerator attributes
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCustomRoutingAcceleratorAttributesUpdate the attributes for a custom routing accelerator. - POSTUpdate custom routing listener
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateCustomRoutingListenerUpdate a listener for a custom routing accelerator. - POSTUpdate endpoint group
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateEndpointGroupUpdate an endpoint group. A resource must be valid and active when you add it as an endpoint. - POSTUpdate listener
/#X-Amz-Target=GlobalAccelerator_V20180706.UpdateListenerUpdate a listener. - POSTWithdraw byoip cidr
/#X-Amz-Target=GlobalAccelerator_V20180706.WithdrawByoipCidrStops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify…
API details
- Base URL
https://globalaccelerator.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 56 operations on 56 pathsPOST 56
- Description format
- AWS Smithy model, API version
2018-08-08 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Global Accelerator in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Global Accelerator collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add custom routing endpoints” (POST /#X-Amz-Target=GlobalAccelerator_V20180706.AddCustomRoutingEndpoints), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Global Accelerator?
Global Accelerator This is the Global Accelerator API Reference . This guide is for developers who need detailed information about Global Accelerator API… It is listed under Developer tools and has 56 endpoints.
Who publishes the AWS Global Accelerator?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Global Accelerator?
Requests go to https://globalaccelerator.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Global Accelerator?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Global Accelerator have?
56 operations on 56 paths (56 POST).
Is forking the AWS Global Accelerator free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.