openapi: 3.0.0
info:
version: '2018-08-08'
x-release: v4
title: 'AWS Global Accelerator #X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints #X Amz Target=GlobalAccelerator V20180706.AddCustomRoutingEndpoints #X Amz Target=GlobalAccelerator V20180706.ListAccelerators API'
description: '<fullname>Global Accelerator</fullname> <p>This is the <i>Global Accelerator API Reference</i>. 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 <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p> <p>Global Accelerator is a service in which you create <i>accelerators</i> 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. </p> <ul> <li> <p>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. </p> </li> <li> <p>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.</p> </li> </ul> <important> <p>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 <code>--region us-west-2</code> on AWS CLI commands.</p> </important> <p>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). </p> <p>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.</p> <important> <p>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 <i>delete</i> 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 <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p> </important> <p>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.</p> <p>For more information about understanding and using Global Accelerator, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>'
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.ListAccelerators'
paths:
/#X-Amz-Target=GlobalAccelerator_V20180706.ListAccelerators:
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: ListAccelerators
description: 'List the accelerators for an Amazon Web Services account. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAcceleratorsResponse'
examples:
ListAccelerators200Example:
summary: Default ListAccelerators 200 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'480':
description: InvalidArgumentException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArgumentException'
examples:
ListAccelerators480Example:
summary: Default ListAccelerators 480 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'481':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
examples:
ListAccelerators481Example:
summary: Default ListAccelerators 481 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
examples:
ListAccelerators482Example:
summary: Default ListAccelerators 482 response
x-microcks-default: true
value:
acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
status: DEPLOYED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListAcceleratorsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- GlobalAccelerator_V20180706.ListAccelerators
summary: Amazon Global Accelerator List Accelerators
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=GlobalAccelerator V20180706.ListAccelerators'
components:
schemas:
IpAddresses:
type: array
items:
$ref: '#/components/schemas/IpAddress'
minItems: 0
maxItems: 2
InvalidArgumentException: {}
Accelerator:
type: object
properties:
AcceleratorArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the accelerator.
Name:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
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.
Enabled:
allOf:
- $ref: '#/components/schemas/GenericBoolean'
- description: <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
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: '<p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator''s static IPv4 addresses.</p> <p>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.</p> <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, 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.</p> <p>For more information about the default DNS name, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>'
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: '<p>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.</p> <p>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.</p> <p>Note: Global Accelerator also assigns a default DNS name, <code>DnsName</code>, to your accelerator that points just to the static IPv4 addresses. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>'
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.
AcceleratorEvents:
type: array
items:
$ref: '#/components/schemas/AcceleratorEvent'
Timestamp:
type: string
format: date-time
IpAddressFamily:
type: string
enum:
- IPv4
- IPv6
ListAcceleratorsRequest:
type: object
title: ListAcceleratorsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The number of Global Accelerator objects that you want to return with this call. The default value is 10.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
AcceleratorEvent:
type: object
properties:
Message:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: A string that contains an <code>Event</code> 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 <code>Timestamp</code> value and <code>Message</code> 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. '
Accelerators:
type: array
items:
$ref: '#/components/schemas/Accelerator'
IpAddress:
type: string
maxLength: 45
MaxResults:
type: integer
minimum: 1
maximum: 100
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'
InvalidNextTokenException: {}
AcceleratorStatus:
type: string
enum:
- DEPLOYED
- IN_PROGRESS
ListAcceleratorsResponse:
type: object
properties:
Accelerators:
allOf:
- $ref: '#/components/schemas/Accelerators'
- description: The list of accelerators for a customer account.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
GenericBoolean:
type: boolean
InternalServiceErrorException: {}
IpAddressType:
type: string
enum:
- IPV4
- DUAL_STACK
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