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 AWS 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 toGlobal 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.
' x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: globalaccelerator x-aws-signingName: globalaccelerator x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/globalaccelerator-2018-08-08.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://globalaccelerator.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Global Accelerator multi-region endpoint - url: https://globalaccelerator.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Global Accelerator multi-region endpoint - url: http://globalaccelerator.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia) - url: https://globalaccelerator.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=GlobalAccelerator V20180706.CreateAccelerator' paths: /#X-Amz-Target=GlobalAccelerator_V20180706.CreateAccelerator: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateAccelerator description:Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
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 AWS CLI commands.
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
IpSets: allOf: - $ref: '#/components/schemas/IpSets' - description: The static IP addresses that Global Accelerator associates with the accelerator. DnsName: allOf: - $ref: '#/components/schemas/GenericString' - description: 'The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator''s static IPv4 addresses.
The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
' Status: allOf: - $ref: '#/components/schemas/AcceleratorStatus' - description: Describes the deployment status of the accelerator. CreatedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the accelerator was created. LastModifiedTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the accelerator was last modified. DualStackDnsName: allOf: - $ref: '#/components/schemas/GenericString' - description: 'The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator''s four static IP addresses: two IPv4 addresses and two IPv6 addresses.
The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.
Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
' Events: allOf: - $ref: '#/components/schemas/AcceleratorEvents' - description: A history of changes that you make to an accelerator in Global Accelerator. description: 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. Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: A string that contains aTag key.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: A string that contains a Tag value.
description: A complex type that contains a Tag key and Tag value.
TagKey:
type: string
minLength: 1
maxLength: 128
AcceleratorEvents:
type: array
items:
$ref: '#/components/schemas/AcceleratorEvent'
Timestamp:
type: string
format: date-time
IpAddressFamily:
type: string
enum:
- IPv4
- IPv6
LimitExceededException: {}
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
AcceleratorEvent:
type: object
properties:
Message:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
Timestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
description: 'A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages. '
IpAddress:
type: string
maxLength: 45
IdempotencyToken:
type: string
maxLength: 255
IpSet:
type: object
properties:
IpFamily:
allOf:
- $ref: '#/components/schemas/GenericString'
- deprecated: true
description: IpFamily is deprecated and has been replaced by IpAddressFamily.IpFamily has been replaced by IpAddressFamily
IpAddresses:
allOf:
- $ref: '#/components/schemas/IpAddresses'
- description: The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
IpAddressFamily:
allOf:
- $ref: '#/components/schemas/IpAddressFamily'
- description: 'The types of IP addresses included in this IP set. '
description: A complex type for the set of IP addresses for an accelerator.
GenericString:
type: string
maxLength: 255
IpSets:
type: array
items:
$ref: '#/components/schemas/IpSet'
CreateAcceleratorRequest:
type: object
required:
- Name
- IdempotencyToken
title: CreateAcceleratorRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
IpAddressType:
allOf:
- $ref: '#/components/schemas/IpAddressType'
- description: The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
IpAddresses:
allOf:
- $ref: '#/components/schemas/IpAddresses'
- description: Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.
You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
Enabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
IdempotencyToken: allOf: - $ref: '#/components/schemas/IdempotencyToken' - description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator. Tags: allOf: - $ref: '#/components/schemas/Tags' - description:Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
AcceleratorStatus: type: string enum: - DEPLOYED - IN_PROGRESS CreateAcceleratorResponse: type: object properties: Accelerator: allOf: - $ref: '#/components/schemas/Accelerator' - description: The accelerator that is created by specifying a listener and the supported IP address types. GenericBoolean: type: boolean InternalServiceErrorException: {} IpAddressType: type: string enum: - IPV4 - DUAL_STACK TagValue: type: string minLength: 0 maxLength: 256 parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/globalaccelerator/ x-hasEquivalentPaths: true