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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/globalaccelerator/ 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=GlobalAccelerator_V20180706.AddCustomRoutingEndpoints: post: operationId: AddCustomRoutingEndpoints description: 'Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.
Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.
By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddCustomRoutingEndpointsResponse' examples: AddCustomRoutingEndpoints200Example: summary: Default AddCustomRoutingEndpoints 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: EndpointAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EndpointAlreadyExistsException' examples: AddCustomRoutingEndpoints480Example: summary: Default AddCustomRoutingEndpoints 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: AddCustomRoutingEndpoints481Example: summary: Default AddCustomRoutingEndpoints 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: AddCustomRoutingEndpoints482Example: summary: Default AddCustomRoutingEndpoints 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: AddCustomRoutingEndpoints483Example: summary: Default AddCustomRoutingEndpoints 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: AddCustomRoutingEndpoints484Example: summary: Default AddCustomRoutingEndpoints 484 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '485': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: AddCustomRoutingEndpoints485Example: summary: Default AddCustomRoutingEndpoints 485 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: AddCustomRoutingEndpoints486Example: summary: Default AddCustomRoutingEndpoints 486 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/AddCustomRoutingEndpointsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.AddCustomRoutingEndpoints summary: Amazon Global Accelerator Add Custom Routing Endpoints x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.AddEndpoints: post: operationId: AddEndpoints description:Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when
you create an endpoint group (with the CreateEndpointGroup API) or when you update an
endpoint group (with the UpdateEndpointGroup API).
There are two advantages to
using AddEndpoints to add endpoints:
It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding.
It's more convenient, because you don't need to specify all of the current endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.
Advertises 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 a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.
To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AdvertiseByoipCidrResponse' examples: AdvertiseByoipCidr200Example: summary: Default AdvertiseByoipCidr 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: AdvertiseByoipCidr480Example: summary: Default AdvertiseByoipCidr 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: AdvertiseByoipCidr481Example: summary: Default AdvertiseByoipCidr 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: AdvertiseByoipCidr482Example: summary: Default AdvertiseByoipCidr 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: ByoipCidrNotFoundException content: application/json: schema: $ref: '#/components/schemas/ByoipCidrNotFoundException' examples: AdvertiseByoipCidr483Example: summary: Default AdvertiseByoipCidr 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: IncorrectCidrStateException content: application/json: schema: $ref: '#/components/schemas/IncorrectCidrStateException' examples: AdvertiseByoipCidr484Example: summary: Default AdvertiseByoipCidr 484 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/AdvertiseByoipCidrRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.AdvertiseByoipCidr summary: Amazon Global Accelerator Advertise Byoip Cidr x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.AllowCustomRoutingTraffic: post: operationId: AllowCustomRoutingTraffic description: 'Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
' responses: '200': description: Success '480': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: AllowCustomRoutingTraffic480Example: summary: Default AllowCustomRoutingTraffic 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: AllowCustomRoutingTraffic481Example: summary: Default AllowCustomRoutingTraffic 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: AllowCustomRoutingTraffic482Example: summary: Default AllowCustomRoutingTraffic 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/AllowCustomRoutingTrafficRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.AllowCustomRoutingTraffic summary: Amazon Global Accelerator Allow Custom Routing Traffic x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.CreateAccelerator: 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.
Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
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.
Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator,
update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
The IP addresses are 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 the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the
accelerator, update the accelerator to set Enabled to false.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
The IP addresses are 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 the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
' responses: '200': description: Success '480': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: DenyCustomRoutingTraffic480Example: summary: Default DenyCustomRoutingTraffic 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: DenyCustomRoutingTraffic481Example: summary: Default DenyCustomRoutingTraffic 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: DenyCustomRoutingTraffic482Example: summary: Default DenyCustomRoutingTraffic 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/DenyCustomRoutingTrafficRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DenyCustomRoutingTraffic summary: Amazon Global Accelerator Deny Custom Routing Traffic x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DeprovisionByoipCidr: post: operationId: DeprovisionByoipCidr description: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.
Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeprovisionByoipCidrResponse' examples: DeprovisionByoipCidr200Example: summary: Default DeprovisionByoipCidr 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: DeprovisionByoipCidr480Example: summary: Default DeprovisionByoipCidr 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: DeprovisionByoipCidr481Example: summary: Default DeprovisionByoipCidr 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeprovisionByoipCidr482Example: summary: Default DeprovisionByoipCidr 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: ByoipCidrNotFoundException content: application/json: schema: $ref: '#/components/schemas/ByoipCidrNotFoundException' examples: DeprovisionByoipCidr483Example: summary: Default DeprovisionByoipCidr 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: IncorrectCidrStateException content: application/json: schema: $ref: '#/components/schemas/IncorrectCidrStateException' examples: DeprovisionByoipCidr484Example: summary: Default DeprovisionByoipCidr 484 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/DeprovisionByoipCidrRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DeprovisionByoipCidr summary: Amazon Global Accelerator Deprovision Byoip Cidr x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeAccelerator: post: operationId: DescribeAccelerator description: 'Describe an accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeAcceleratorResponse' examples: DescribeAccelerator200Example: summary: Default DescribeAccelerator 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: DescribeAccelerator480Example: summary: Default DescribeAccelerator 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: DescribeAccelerator481Example: summary: Default DescribeAccelerator 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: DescribeAccelerator482Example: summary: Default DescribeAccelerator 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/DescribeAcceleratorRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeAccelerator summary: Amazon Global Accelerator Describe Accelerator x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeAcceleratorAttributes: post: operationId: DescribeAcceleratorAttributes description: 'Describe the attributes of an accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeAcceleratorAttributesResponse' examples: DescribeAcceleratorAttributes200Example: summary: Default DescribeAcceleratorAttributes 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: DescribeAcceleratorAttributes480Example: summary: Default DescribeAcceleratorAttributes 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: DescribeAcceleratorAttributes481Example: summary: Default DescribeAcceleratorAttributes 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: DescribeAcceleratorAttributes482Example: summary: Default DescribeAcceleratorAttributes 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/DescribeAcceleratorAttributesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeAcceleratorAttributes summary: Amazon Global Accelerator Describe Accelerator Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingAccelerator: post: operationId: DescribeCustomRoutingAccelerator description: 'Describe a custom routing accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeCustomRoutingAcceleratorResponse' examples: DescribeCustomRoutingAccelerator200Example: summary: Default DescribeCustomRoutingAccelerator 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: DescribeCustomRoutingAccelerator480Example: summary: Default DescribeCustomRoutingAccelerator 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: DescribeCustomRoutingAccelerator481Example: summary: Default DescribeCustomRoutingAccelerator 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: DescribeCustomRoutingAccelerator482Example: summary: Default DescribeCustomRoutingAccelerator 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/DescribeCustomRoutingAcceleratorRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeCustomRoutingAccelerator summary: Amazon Global Accelerator Describe Custom Routing Accelerator x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingAcceleratorAttributes: post: operationId: DescribeCustomRoutingAcceleratorAttributes description: 'Describe the attributes of a custom routing accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeCustomRoutingAcceleratorAttributesResponse' examples: DescribeCustomRoutingAcceleratorAttributes200Example: summary: Default DescribeCustomRoutingAcceleratorAttributes 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: DescribeCustomRoutingAcceleratorAttributes480Example: summary: Default DescribeCustomRoutingAcceleratorAttributes 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: DescribeCustomRoutingAcceleratorAttributes481Example: summary: Default DescribeCustomRoutingAcceleratorAttributes 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: DescribeCustomRoutingAcceleratorAttributes482Example: summary: Default DescribeCustomRoutingAcceleratorAttributes 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/DescribeCustomRoutingAcceleratorAttributesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeCustomRoutingAcceleratorAttributes summary: Amazon Global Accelerator Describe Custom Routing Accelerator Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingEndpointGroup: post: operationId: DescribeCustomRoutingEndpointGroup description: 'Describe an endpoint group for a custom routing accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeCustomRoutingEndpointGroupResponse' examples: DescribeCustomRoutingEndpointGroup200Example: summary: Default DescribeCustomRoutingEndpointGroup 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: DescribeCustomRoutingEndpointGroup480Example: summary: Default DescribeCustomRoutingEndpointGroup 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: DescribeCustomRoutingEndpointGroup481Example: summary: Default DescribeCustomRoutingEndpointGroup 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: DescribeCustomRoutingEndpointGroup482Example: summary: Default DescribeCustomRoutingEndpointGroup 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/DescribeCustomRoutingEndpointGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeCustomRoutingEndpointGroup summary: Amazon Global Accelerator Describe Custom Routing Endpoint Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeCustomRoutingListener: post: operationId: DescribeCustomRoutingListener description: The description of a listener for a custom routing accelerator. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeCustomRoutingListenerResponse' examples: DescribeCustomRoutingListener200Example: summary: Default DescribeCustomRoutingListener 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: DescribeCustomRoutingListener480Example: summary: Default DescribeCustomRoutingListener 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: ListenerNotFoundException content: application/json: schema: $ref: '#/components/schemas/ListenerNotFoundException' examples: DescribeCustomRoutingListener481Example: summary: Default DescribeCustomRoutingListener 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: DescribeCustomRoutingListener482Example: summary: Default DescribeCustomRoutingListener 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/DescribeCustomRoutingListenerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeCustomRoutingListener summary: Amazon Global Accelerator Describe Custom Routing Listener x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeEndpointGroup: post: operationId: DescribeEndpointGroup description: 'Describe an endpoint group. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEndpointGroupResponse' examples: DescribeEndpointGroup200Example: summary: Default DescribeEndpointGroup 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: DescribeEndpointGroup480Example: summary: Default DescribeEndpointGroup 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: DescribeEndpointGroup481Example: summary: Default DescribeEndpointGroup 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: DescribeEndpointGroup482Example: summary: Default DescribeEndpointGroup 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/DescribeEndpointGroupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeEndpointGroup summary: Amazon Global Accelerator Describe Endpoint Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.DescribeListener: post: operationId: DescribeListener description: 'Describe a listener. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeListenerResponse' examples: DescribeListener200Example: summary: Default DescribeListener 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: DescribeListener480Example: summary: Default DescribeListener 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: ListenerNotFoundException content: application/json: schema: $ref: '#/components/schemas/ListenerNotFoundException' examples: DescribeListener481Example: summary: Default DescribeListener 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: DescribeListener482Example: summary: Default DescribeListener 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/DescribeListenerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.DescribeListener summary: Amazon Global Accelerator Describe Listener x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListAccelerators: 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 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListByoipCidrs: post: operationId: ListByoipCidrs description: Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListByoipCidrsResponse' examples: ListByoipCidrs200Example: summary: Default ListByoipCidrs 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListByoipCidrs480Example: summary: Default ListByoipCidrs 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: ListByoipCidrs481Example: summary: Default ListByoipCidrs 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListByoipCidrs482Example: summary: Default ListByoipCidrs 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListByoipCidrs483Example: summary: Default ListByoipCidrs 483 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/ListByoipCidrsRequest' 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.ListByoipCidrs summary: Amazon Global Accelerator List Byoip Cidrs x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingAccelerators: post: operationId: ListCustomRoutingAccelerators description: 'List the custom routing accelerators for an Amazon Web Services account. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCustomRoutingAcceleratorsResponse' examples: ListCustomRoutingAccelerators200Example: summary: Default ListCustomRoutingAccelerators 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: ListCustomRoutingAccelerators480Example: summary: Default ListCustomRoutingAccelerators 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: ListCustomRoutingAccelerators481Example: summary: Default ListCustomRoutingAccelerators 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: ListCustomRoutingAccelerators482Example: summary: Default ListCustomRoutingAccelerators 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/ListCustomRoutingAcceleratorsRequest' 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.ListCustomRoutingAccelerators summary: Amazon Global Accelerator List Custom Routing Accelerators x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingEndpointGroups: post: operationId: ListCustomRoutingEndpointGroups description: 'List the endpoint groups that are associated with a listener for a custom routing accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCustomRoutingEndpointGroupsResponse' examples: ListCustomRoutingEndpointGroups200Example: summary: Default ListCustomRoutingEndpointGroups 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: ListenerNotFoundException content: application/json: schema: $ref: '#/components/schemas/ListenerNotFoundException' examples: ListCustomRoutingEndpointGroups480Example: summary: Default ListCustomRoutingEndpointGroups 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: ListCustomRoutingEndpointGroups481Example: summary: Default ListCustomRoutingEndpointGroups 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: ListCustomRoutingEndpointGroups482Example: summary: Default ListCustomRoutingEndpointGroups 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListCustomRoutingEndpointGroups483Example: summary: Default ListCustomRoutingEndpointGroups 483 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/ListCustomRoutingEndpointGroupsRequest' 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.ListCustomRoutingEndpointGroups summary: Amazon Global Accelerator List Custom Routing Endpoint Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingListeners: post: operationId: ListCustomRoutingListeners description: 'List the listeners for a custom routing accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCustomRoutingListenersResponse' examples: ListCustomRoutingListeners200Example: summary: Default ListCustomRoutingListeners 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: ListCustomRoutingListeners480Example: summary: Default ListCustomRoutingListeners 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: ListCustomRoutingListeners481Example: summary: Default ListCustomRoutingListeners 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListCustomRoutingListeners482Example: summary: Default ListCustomRoutingListeners 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListCustomRoutingListeners483Example: summary: Default ListCustomRoutingListeners 483 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/ListCustomRoutingListenersRequest' 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.ListCustomRoutingListeners summary: Amazon Global Accelerator List Custom Routing Listeners x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappings: post: operationId: ListCustomRoutingPortMappings description: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. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCustomRoutingPortMappingsResponse' examples: ListCustomRoutingPortMappings200Example: summary: Default ListCustomRoutingPortMappings 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: ListCustomRoutingPortMappings480Example: summary: Default ListCustomRoutingPortMappings 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: ListCustomRoutingPortMappings481Example: summary: Default ListCustomRoutingPortMappings 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: ListCustomRoutingPortMappings482Example: summary: Default ListCustomRoutingPortMappings 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: ListCustomRoutingPortMappings483Example: summary: Default ListCustomRoutingPortMappings 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListCustomRoutingPortMappings484Example: summary: Default ListCustomRoutingPortMappings 484 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/ListCustomRoutingPortMappingsRequest' 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.ListCustomRoutingPortMappings summary: Amazon Global Accelerator List Custom Routing Port Mappings x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingPortMappingsByDestination: post: operationId: ListCustomRoutingPortMappingsByDestination description: List 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 is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCustomRoutingPortMappingsByDestinationResponse' examples: ListCustomRoutingPortMappingsByDestination200Example: summary: Default ListCustomRoutingPortMappingsByDestination 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: ListCustomRoutingPortMappingsByDestination480Example: summary: Default ListCustomRoutingPortMappingsByDestination 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: ListCustomRoutingPortMappingsByDestination481Example: summary: Default ListCustomRoutingPortMappingsByDestination 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: EndpointNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointNotFoundException' examples: ListCustomRoutingPortMappingsByDestination482Example: summary: Default ListCustomRoutingPortMappingsByDestination 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListCustomRoutingPortMappingsByDestination483Example: summary: Default ListCustomRoutingPortMappingsByDestination 483 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/ListCustomRoutingPortMappingsByDestinationRequest' 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.ListCustomRoutingPortMappingsByDestination summary: Amazon Global Accelerator List Custom Routing Port Mappings by Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListEndpointGroups: post: operationId: ListEndpointGroups description: 'List the endpoint groups that are associated with a listener. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEndpointGroupsResponse' examples: ListEndpointGroups200Example: summary: Default ListEndpointGroups 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: ListenerNotFoundException content: application/json: schema: $ref: '#/components/schemas/ListenerNotFoundException' examples: ListEndpointGroups480Example: summary: Default ListEndpointGroups 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: ListEndpointGroups481Example: summary: Default ListEndpointGroups 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: ListEndpointGroups482Example: summary: Default ListEndpointGroups 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListEndpointGroups483Example: summary: Default ListEndpointGroups 483 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/ListEndpointGroupsRequest' 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.ListEndpointGroups summary: Amazon Global Accelerator List Endpoint Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListListeners: post: operationId: ListListeners description: 'List the listeners for an accelerator. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListListenersResponse' examples: ListListeners200Example: summary: Default ListListeners 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: ListListeners480Example: summary: Default ListListeners 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: ListListeners481Example: summary: Default ListListeners 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListListeners482Example: summary: Default ListListeners 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListListeners483Example: summary: Default ListListeners 483 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/ListListenersRequest' 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.ListListeners summary: Amazon Global Accelerator List Listeners x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ListTagsForResource: post: operationId: ListTagsForResource description:List all tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: ListTagsForResource482Example: summary: Default ListTagsForResource 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/ListTagsForResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.ListTagsForResource summary: Amazon Global Accelerator List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.ProvisionByoipCidr: post: operationId: ProvisionByoipCidr description: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. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvisionByoipCidrResponse' examples: ProvisionByoipCidr200Example: summary: Default ProvisionByoipCidr 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: ProvisionByoipCidr480Example: summary: Default ProvisionByoipCidr 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: ProvisionByoipCidr481Example: summary: Default ProvisionByoipCidr 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: ProvisionByoipCidr482Example: summary: Default ProvisionByoipCidr 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ProvisionByoipCidr483Example: summary: Default ProvisionByoipCidr 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: IncorrectCidrStateException content: application/json: schema: $ref: '#/components/schemas/IncorrectCidrStateException' examples: ProvisionByoipCidr484Example: summary: Default ProvisionByoipCidr 484 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/ProvisionByoipCidrRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.ProvisionByoipCidr summary: Amazon Global Accelerator Provision Byoip Cidr x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.RemoveCustomRoutingEndpoints: post: operationId: RemoveCustomRoutingEndpoints description: Remove endpoints from a custom routing accelerator. responses: '200': description: Success '480': description: EndpointGroupNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointGroupNotFoundException' examples: RemoveCustomRoutingEndpoints480Example: summary: Default RemoveCustomRoutingEndpoints 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: EndpointNotFoundException content: application/json: schema: $ref: '#/components/schemas/EndpointNotFoundException' examples: RemoveCustomRoutingEndpoints481Example: summary: Default RemoveCustomRoutingEndpoints 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: RemoveCustomRoutingEndpoints482Example: summary: Default RemoveCustomRoutingEndpoints 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: RemoveCustomRoutingEndpoints483Example: summary: Default RemoveCustomRoutingEndpoints 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: RemoveCustomRoutingEndpoints484Example: summary: Default RemoveCustomRoutingEndpoints 484 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: RemoveCustomRoutingEndpoints485Example: summary: Default RemoveCustomRoutingEndpoints 485 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/RemoveCustomRoutingEndpointsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.RemoveCustomRoutingEndpoints summary: Amazon Global Accelerator Remove Custom Routing Endpoints x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.RemoveEndpoints: post: operationId: RemoveEndpoints description:Remove endpoints from an endpoint group.
The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove
endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation.
There are two advantages to using AddEndpoints to remove endpoints instead:
It's more convenient, because you only need to specify the endpoints that you want to
remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the
endpoints that remain in the group.
Add tags to an accelerator resource.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' examples: TagResource200Example: summary: Default TagResource 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: TagResource482Example: summary: Default TagResource 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/TagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.TagResource summary: Amazon Global Accelerator Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.UntagResource: post: operationId: UntagResource description:Remove 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 even if you attempt to remove tags from an accelerator that was already removed.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: AcceleratorNotFoundException content: application/json: schema: $ref: '#/components/schemas/AcceleratorNotFoundException' examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: UntagResource482Example: summary: Default UntagResource 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/UntagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.UntagResource summary: Amazon Global Accelerator Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateAccelerator: post: operationId: UpdateAccelerator description:Update an accelerator.
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.
Stops 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 different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WithdrawByoipCidrResponse' examples: WithdrawByoipCidr200Example: summary: Default WithdrawByoipCidr 200 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' examples: WithdrawByoipCidr480Example: summary: Default WithdrawByoipCidr 480 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' examples: WithdrawByoipCidr481Example: summary: Default WithdrawByoipCidr 481 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: WithdrawByoipCidr482Example: summary: Default WithdrawByoipCidr 482 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '483': description: ByoipCidrNotFoundException content: application/json: schema: $ref: '#/components/schemas/ByoipCidrNotFoundException' examples: WithdrawByoipCidr483Example: summary: Default WithdrawByoipCidr 483 response x-microcks-default: true value: acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123 status: DEPLOYED '484': description: IncorrectCidrStateException content: application/json: schema: $ref: '#/components/schemas/IncorrectCidrStateException' examples: WithdrawByoipCidr484Example: summary: Default WithdrawByoipCidr 484 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/WithdrawByoipCidrRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GlobalAccelerator_V20180706.WithdrawByoipCidr summary: Amazon Global Accelerator Withdraw Byoip Cidr x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 schemas: AddCustomRoutingEndpointsResponse: type: object properties: EndpointDescriptions: allOf: - $ref: '#/components/schemas/CustomRoutingEndpointDescriptions' - description: The endpoint objects added to the custom routing accelerator. EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint. AddCustomRoutingEndpointsRequest: type: object required: - EndpointConfigurations - EndpointGroupArn title: AddCustomRoutingEndpointsRequest properties: EndpointConfigurations: allOf: - $ref: '#/components/schemas/CustomRoutingEndpointConfigurations' - description: The list of endpoint objects to add to a custom routing accelerator. EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint. EndpointAlreadyExistsException: {} EndpointGroupNotFoundException: {} InternalServiceErrorException: {} InvalidArgumentException: {} LimitExceededException: {} AccessDeniedException: {} ConflictException: {} AddEndpointsResponse: type: object properties: EndpointDescriptions: allOf: - $ref: '#/components/schemas/EndpointDescriptions' - description: The list of endpoint objects. EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. AddEndpointsRequest: type: object required: - EndpointConfigurations - EndpointGroupArn title: AddEndpointsRequest properties: EndpointConfigurations: allOf: - $ref: '#/components/schemas/EndpointConfigurations' - description: The list of endpoint objects. EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. TransactionInProgressException: {} AdvertiseByoipCidrResponse: type: object properties: ByoipCidr: allOf: - $ref: '#/components/schemas/ByoipCidr' - description: Information about the address range. AdvertiseByoipCidrRequest: type: object required: - Cidr title: AdvertiseByoipCidrRequest properties: Cidr: allOf: - $ref: '#/components/schemas/GenericString' - description: The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range. ByoipCidrNotFoundException: {} IncorrectCidrStateException: {} AllowCustomRoutingTrafficRequest: type: object required: - EndpointGroupArn - EndpointId title: AllowCustomRoutingTrafficRequest properties: EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description: An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. DestinationAddresses: allOf: - $ref: '#/components/schemas/DestinationAddresses' - description:A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not
specified.
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.
When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
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. 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.
CreateCustomRoutingAcceleratorResponse: type: object properties: Accelerator: allOf: - $ref: '#/components/schemas/CustomRoutingAccelerator' - description: The accelerator that is created. CreateCustomRoutingAcceleratorRequest: type: object required: - Name - IdempotencyToken title: CreateCustomRoutingAcceleratorRequest properties: Name: allOf: - $ref: '#/components/schemas/GenericString' - description: The name of a custom routing accelerator. The name can have a maximum of 64 characters, 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 custom routing accelerator, the value must be IPV4. 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 the request. 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.
CreateCustomRoutingEndpointGroupResponse: type: object properties: EndpointGroup: allOf: - $ref: '#/components/schemas/CustomRoutingEndpointGroup' - description: The information about the endpoint group created for a custom routing accelerator. CreateCustomRoutingEndpointGroupRequest: type: object required: - ListenerArn - EndpointGroupRegion - DestinationConfigurations - IdempotencyToken title: CreateCustomRoutingEndpointGroupRequest properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener for a custom routing endpoint. EndpointGroupRegion: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region. DestinationConfigurations: allOf: - $ref: '#/components/schemas/CustomRoutingDestinationConfigurations' - description: Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on. IdempotencyToken: allOf: - $ref: '#/components/schemas/IdempotencyToken' - description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. AcceleratorNotFoundException: {} EndpointGroupAlreadyExistsException: {} ListenerNotFoundException: {} InvalidPortRangeException: {} CreateCustomRoutingListenerResponse: type: object properties: Listener: allOf: - $ref: '#/components/schemas/CustomRoutingListener' - description: The listener that you've created for a custom routing accelerator. CreateCustomRoutingListenerRequest: type: object required: - AcceleratorArn - PortRanges - IdempotencyToken title: CreateCustomRoutingListenerRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the accelerator for a custom routing listener. PortRanges: allOf: - $ref: '#/components/schemas/PortRanges' - description:The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
IdempotencyToken: allOf: - $ref: '#/components/schemas/IdempotencyToken' - description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. CreateEndpointGroupResponse: type: object properties: EndpointGroup: allOf: - $ref: '#/components/schemas/EndpointGroup' - description: The information about the endpoint group that was created. CreateEndpointGroupRequest: type: object required: - ListenerArn - EndpointGroupRegion - IdempotencyToken title: CreateEndpointGroupRequest properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener. EndpointGroupRegion: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region. EndpointConfigurations: allOf: - $ref: '#/components/schemas/EndpointConfigurations' - description: The list of endpoint objects. TrafficDialPercentage: allOf: - $ref: '#/components/schemas/TrafficDialPercentage' - description:The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
HealthCheckPort: allOf: - $ref: '#/components/schemas/HealthCheckPort' - description: The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list. HealthCheckProtocol: allOf: - $ref: '#/components/schemas/HealthCheckProtocol' - description: The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP. HealthCheckPath: allOf: - $ref: '#/components/schemas/HealthCheckPath' - description: If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). HealthCheckIntervalSeconds: allOf: - $ref: '#/components/schemas/HealthCheckIntervalSeconds' - description: The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. ThresholdCount: allOf: - $ref: '#/components/schemas/ThresholdCount' - description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. IdempotencyToken: allOf: - $ref: '#/components/schemas/IdempotencyToken' - description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request. PortOverrides: allOf: - $ref: '#/components/schemas/PortOverrides' - description:Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
CreateListenerResponse: type: object properties: Listener: allOf: - $ref: '#/components/schemas/Listener' - description: The listener that you've created. CreateListenerRequest: type: object required: - AcceleratorArn - PortRanges - Protocol - IdempotencyToken title: CreateListenerRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of your accelerator. PortRanges: allOf: - $ref: '#/components/schemas/PortRanges' - description: The list of port ranges to support for connections from clients to your accelerator. Protocol: allOf: - $ref: '#/components/schemas/Protocol' - description: The protocol for connections from clients to your accelerator. ClientAffinity: allOf: - $ref: '#/components/schemas/ClientAffinity' - description:Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.
Global Accelerator uses a consistent-flow hashing algorithm to choose the
optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP
address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global
Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same
endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source
(client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.
When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
DeprovisionByoipCidrResponse: type: object properties: ByoipCidr: allOf: - $ref: '#/components/schemas/ByoipCidr' - description: Information about the address range. DeprovisionByoipCidrRequest: type: object required: - Cidr title: DeprovisionByoipCidrRequest properties: Cidr: allOf: - $ref: '#/components/schemas/GenericString' - description: The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. DescribeAcceleratorResponse: type: object properties: Accelerator: allOf: - $ref: '#/components/schemas/Accelerator' - description: The description of the accelerator. DescribeAcceleratorRequest: type: object required: - AcceleratorArn title: DescribeAcceleratorRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the accelerator to describe. DescribeAcceleratorAttributesResponse: type: object properties: AcceleratorAttributes: allOf: - $ref: '#/components/schemas/AcceleratorAttributes' - description: The attributes of the accelerator. DescribeAcceleratorAttributesRequest: type: object required: - AcceleratorArn title: DescribeAcceleratorAttributesRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe. DescribeCustomRoutingAcceleratorResponse: type: object properties: Accelerator: allOf: - $ref: '#/components/schemas/CustomRoutingAccelerator' - description: The description of the custom routing accelerator. DescribeCustomRoutingAcceleratorRequest: type: object required: - AcceleratorArn title: DescribeCustomRoutingAcceleratorRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the accelerator to describe. DescribeCustomRoutingAcceleratorAttributesResponse: type: object properties: AcceleratorAttributes: allOf: - $ref: '#/components/schemas/CustomRoutingAcceleratorAttributes' - description: The attributes of the custom routing accelerator. DescribeCustomRoutingAcceleratorAttributesRequest: type: object required: - AcceleratorArn title: DescribeCustomRoutingAcceleratorAttributesRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for. DescribeCustomRoutingEndpointGroupResponse: type: object properties: EndpointGroup: allOf: - $ref: '#/components/schemas/CustomRoutingEndpointGroup' - description: The description of an endpoint group for a custom routing accelerator. DescribeCustomRoutingEndpointGroupRequest: type: object required: - EndpointGroupArn title: DescribeCustomRoutingEndpointGroupRequest properties: EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group to describe. DescribeCustomRoutingListenerResponse: type: object properties: Listener: allOf: - $ref: '#/components/schemas/CustomRoutingListener' - description: The description of a listener for a custom routing accelerator. DescribeCustomRoutingListenerRequest: type: object required: - ListenerArn title: DescribeCustomRoutingListenerRequest properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener to describe. DescribeEndpointGroupResponse: type: object properties: EndpointGroup: allOf: - $ref: '#/components/schemas/EndpointGroup' - description: The description of an endpoint group. DescribeEndpointGroupRequest: type: object required: - EndpointGroupArn title: DescribeEndpointGroupRequest properties: EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group to describe. DescribeListenerResponse: type: object properties: Listener: allOf: - $ref: '#/components/schemas/Listener' - description: The description of a listener. DescribeListenerRequest: type: object required: - ListenerArn title: DescribeListenerRequest properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener to describe. 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. 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. InvalidNextTokenException: {} ListByoipCidrsResponse: type: object properties: ByoipCidrs: allOf: - $ref: '#/components/schemas/ByoipCidrs' - description: Information about your address ranges. NextToken: allOf: - $ref: '#/components/schemas/GenericString' - description: The token for the next page of results. ListByoipCidrsRequest: type: object title: ListByoipCidrsRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next page of results.
ListCustomRoutingAcceleratorsResponse:
type: object
properties:
Accelerators:
allOf:
- $ref: '#/components/schemas/CustomRoutingAccelerators'
- description: The list of custom routing 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.
ListCustomRoutingAcceleratorsRequest:
type: object
title: ListCustomRoutingAcceleratorsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The number of custom routing 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.
ListCustomRoutingEndpointGroupsResponse:
type: object
properties:
EndpointGroups:
allOf:
- $ref: '#/components/schemas/CustomRoutingEndpointGroups'
- description: The list of the endpoint groups associated with a listener for a custom routing accelerator.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
ListCustomRoutingEndpointGroupsRequest:
type: object
required:
- ListenerArn
title: ListCustomRoutingEndpointGroupsRequest
properties:
ListenerArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The number of endpoint group 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.
ListCustomRoutingListenersResponse:
type: object
properties:
Listeners:
allOf:
- $ref: '#/components/schemas/CustomRoutingListeners'
- description: The list of listeners for a custom routing accelerator.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
ListCustomRoutingListenersRequest:
type: object
required:
- AcceleratorArn
title: ListCustomRoutingListenersRequest
properties:
AcceleratorArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the accelerator to list listeners for.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The number of listener 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.
ListCustomRoutingPortMappingsResponse:
type: object
properties:
PortMappings:
allOf:
- $ref: '#/components/schemas/PortMappings'
- description: The port mappings for a custom routing accelerator.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
ListCustomRoutingPortMappingsRequest:
type: object
required:
- AcceleratorArn
title: ListCustomRoutingPortMappingsRequest
properties:
AcceleratorArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
EndpointGroupArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
MaxResults:
allOf:
- $ref: '#/components/schemas/PortMappingsMaxResults'
- description: The number of destination port mappings 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.
ListCustomRoutingPortMappingsByDestinationResponse:
type: object
properties:
DestinationPortMappings:
allOf:
- $ref: '#/components/schemas/DestinationPortMappings'
- description: The port mappings for the endpoint IP address that you specified in the request.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
ListCustomRoutingPortMappingsByDestinationRequest:
type: object
required:
- EndpointId
- DestinationAddress
title: ListCustomRoutingPortMappingsByDestinationRequest
properties:
EndpointId:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The ID for the virtual private cloud (VPC) subnet.
DestinationAddress:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
MaxResults:
allOf:
- $ref: '#/components/schemas/PortMappingsMaxResults'
- description: The number of destination port mappings 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.
EndpointNotFoundException: {}
ListEndpointGroupsResponse:
type: object
properties:
EndpointGroups:
allOf:
- $ref: '#/components/schemas/EndpointGroups'
- description: The list of the endpoint groups associated with a listener.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
ListEndpointGroupsRequest:
type: object
required:
- ListenerArn
title: ListEndpointGroupsRequest
properties:
ListenerArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the listener.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The number of endpoint group 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.
ListListenersResponse:
type: object
properties:
Listeners:
allOf:
- $ref: '#/components/schemas/Listeners'
- description: The list of listeners for an accelerator.
NextToken:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The token for the next set of results. You receive this token from a previous call.
ListListenersRequest:
type: object
required:
- AcceleratorArn
title: ListListenersRequest
properties:
AcceleratorArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The number of listener 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.
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: Root level tag for the Tags parameters.
ListTagsForResourceRequest:
type: object
required:
- ResourceArn
title: ListTagsForResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
ProvisionByoipCidrResponse:
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- description: Information about the address range.
ProvisionByoipCidrRequest:
type: object
required:
- Cidr
- CidrAuthorizationContext
title: ProvisionByoipCidrRequest
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that
you've brought to this or another Region.
CidrAuthorizationContext:
allOf:
- $ref: '#/components/schemas/CidrAuthorizationContext'
- description: 'A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. '
RemoveCustomRoutingEndpointsRequest:
type: object
required:
- EndpointIds
- EndpointGroupArn
title: RemoveCustomRoutingEndpointsRequest
properties:
EndpointIds:
allOf:
- $ref: '#/components/schemas/EndpointIds'
- description: 'The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs. '
EndpointGroupArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.
RemoveEndpointsRequest:
type: object
required:
- EndpointIdentifiers
- EndpointGroupArn
title: RemoveEndpointsRequest
properties:
EndpointIdentifiers:
allOf:
- $ref: '#/components/schemas/EndpointIdentifiers'
- description: The identifiers of the endpoints that you want to remove.
EndpointGroupArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the endpoint group.
TagResourceResponse:
type: object
properties: {}
TagResourceRequest:
type: object
required:
- ResourceArn
- Tags
title: TagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: The tags to add to a resource. A tag consists of a key and a value that you define.
UntagResourceResponse:
type: object
properties: {}
UntagResourceRequest:
type: object
required:
- ResourceArn
- TagKeys
title: UntagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeys'
- description: The tag key pairs that you want to remove from the specified resources.
UpdateAcceleratorResponse:
type: object
properties:
Accelerator:
allOf:
- $ref: '#/components/schemas/Accelerator'
- description: Information about the updated accelerator.
UpdateAcceleratorRequest:
type: object
required:
- AcceleratorArn
title: UpdateAcceleratorRequest
properties:
AcceleratorArn:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The Amazon Resource Name (ARN) of the accelerator to update.
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.
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, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
UpdateAcceleratorAttributesResponse: type: object properties: AcceleratorAttributes: allOf: - $ref: '#/components/schemas/AcceleratorAttributes' - description: Updated attributes for the accelerator. UpdateAcceleratorAttributesRequest: type: object required: - AcceleratorArn title: UpdateAcceleratorAttributesRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the accelerator that you want to update. FlowLogsEnabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be
specified.
For more information, see Flow Logs in the Global Accelerator Developer Guide.
FlowLogsS3Bucket: allOf: - $ref: '#/components/schemas/GenericString' - description: The name of the Amazon S3 bucket for the flow logs. Attribute is required ifFlowLogsEnabled is true. The bucket must exist and have a bucket policy
that grants Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
UpdateCustomRoutingAcceleratorResponse: type: object properties: Accelerator: allOf: - $ref: '#/components/schemas/CustomRoutingAccelerator' - description: Information about the updated custom routing accelerator. UpdateCustomRoutingAcceleratorRequest: type: object required: - AcceleratorArn title: UpdateCustomRoutingAcceleratorRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the accelerator to update. 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 custom routing accelerator, the value must be IPV4. 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, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
UpdateCustomRoutingAcceleratorAttributesResponse: type: object properties: AcceleratorAttributes: allOf: - $ref: '#/components/schemas/CustomRoutingAcceleratorAttributes' - description: Updated custom routing accelerator. UpdateCustomRoutingAcceleratorAttributesRequest: type: object required: - AcceleratorArn title: UpdateCustomRoutingAcceleratorAttributesRequest properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for. FlowLogsEnabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be
specified.
For more information, see Flow logs in the Global Accelerator Developer Guide.
FlowLogsS3Bucket: allOf: - $ref: '#/components/schemas/GenericString' - description: The name of the Amazon S3 bucket for the flow logs. Attribute is required ifFlowLogsEnabled is true. The bucket must exist and have a bucket policy
that grants Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
UpdateCustomRoutingListenerResponse: type: object properties: Listener: allOf: - $ref: '#/components/schemas/CustomRoutingListener' - description: Information for the updated listener for a custom routing accelerator. UpdateCustomRoutingListenerRequest: type: object required: - ListenerArn - PortRanges title: UpdateCustomRoutingListenerRequest properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener to update. PortRanges: allOf: - $ref: '#/components/schemas/PortRanges' - description:The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
UpdateEndpointGroupResponse: type: object properties: EndpointGroup: allOf: - $ref: '#/components/schemas/EndpointGroup' - description: The information about the endpoint group that was updated. UpdateEndpointGroupRequest: type: object required: - EndpointGroupArn title: UpdateEndpointGroupRequest properties: EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. EndpointConfigurations: allOf: - $ref: '#/components/schemas/EndpointConfigurations' - description: The list of endpoint objects. A resource must be valid and active when you add it as an endpoint. TrafficDialPercentage: allOf: - $ref: '#/components/schemas/TrafficDialPercentage' - description:The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
HealthCheckPort: allOf: - $ref: '#/components/schemas/HealthCheckPort' - description: The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list. HealthCheckProtocol: allOf: - $ref: '#/components/schemas/HealthCheckProtocol' - description: The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP. HealthCheckPath: allOf: - $ref: '#/components/schemas/HealthCheckPath' - description: If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/). HealthCheckIntervalSeconds: allOf: - $ref: '#/components/schemas/HealthCheckIntervalSeconds' - description: The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30. ThresholdCount: allOf: - $ref: '#/components/schemas/ThresholdCount' - description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. PortOverrides: allOf: - $ref: '#/components/schemas/PortOverrides' - description:Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
UpdateListenerResponse: type: object properties: Listener: allOf: - $ref: '#/components/schemas/Listener' - description: Information for the updated listener. UpdateListenerRequest: type: object required: - ListenerArn title: UpdateListenerRequest properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener to update. PortRanges: allOf: - $ref: '#/components/schemas/PortRanges' - description: The updated list of port ranges for the connections from clients to the accelerator. Protocol: allOf: - $ref: '#/components/schemas/Protocol' - description: The updated protocol for the connections from clients to the accelerator. ClientAffinity: allOf: - $ref: '#/components/schemas/ClientAffinity' - description:Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.
Global Accelerator uses a consistent-flow hashing algorithm to choose the
optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP
address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global
Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same
endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source
(client) IP address and destination IP address—to select the hash value.
The default value is NONE.
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. AcceleratorAttributes: type: object properties: FlowLogsEnabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be
specified.
For more information, see Flow logs in the Global Accelerator Developer Guide.
FlowLogsS3Bucket: allOf: - $ref: '#/components/schemas/GenericString' - description: The name of the Amazon S3 bucket for the flow logs. Attribute is required ifFlowLogsEnabled is true. The bucket must exist and have a bucket policy
that grants Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
description: Attributes of an accelerator. AcceleratorEvent: type: object properties: Message: allOf: - $ref: '#/components/schemas/GenericString' - description: A string that contains anEvent 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. '
Accelerators:
type: array
items:
$ref: '#/components/schemas/Accelerator'
CustomRoutingEndpointConfigurations:
type: array
items:
$ref: '#/components/schemas/CustomRoutingEndpointConfiguration'
minItems: 1
maxItems: 20
CustomRoutingEndpointDescriptions:
type: array
items:
$ref: '#/components/schemas/CustomRoutingEndpointDescription'
EndpointConfigurations:
type: array
items:
$ref: '#/components/schemas/EndpointConfiguration'
minItems: 0
maxItems: 10
EndpointDescriptions:
type: array
items:
$ref: '#/components/schemas/EndpointDescription'
ByoipCidr:
type: object
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The address range, in CIDR notation.
State:
allOf:
- $ref: '#/components/schemas/ByoipCidrState'
- description: The state of the address pool.
Events:
allOf:
- $ref: '#/components/schemas/ByoipCidrEvents'
- description: A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
description: Information about an IP address range that is provisioned for use with your Amazon Web Services resources through bring your own IP address (BYOIP).
The following
describes each BYOIP State that your IP address range can be in.
PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with Global Accelerator.
READY — The address range is provisioned with Global Accelerator and can be advertised.
PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to advertise an address range but it is not yet being advertised.
ADVERTISING — The address range is being advertised by Global Accelerator.
PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by Global Accelerator.
PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from Global Accelerator but it is still provisioned.
DEPROVISIONED — The address range is deprovisioned from Global Accelerator.
FAILED_PROVISION — The request to provision the address range from 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 Amazon Web Services support.
FAILED_ADVERTISING — The request for 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 Amazon Web Services support.
FAILED_WITHDRAW — The request to withdraw the address range from advertising by 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 Amazon Web Services support.
FAILED_DEPROVISION — The request to deprovision the address range from 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 Amazon Web Services support.
Event message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring
your own IP address (BYOIP).
Timestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
description: A complex type that contains a Message and a Timestamp value for changes that you make in the status of an IP address range that you bring to Global
Accelerator through bring your own IP address (BYOIP).
ByoipCidrs:
type: array
items:
$ref: '#/components/schemas/ByoipCidr'
CidrAuthorizationContext:
type: object
required:
- Message
- Signature
properties:
Message:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The plain-text authorization message for the prefix and account.
Signature:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The signed authorization message for the prefix and account.
description: Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP).
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
ClientAffinity: type: string enum: - NONE - SOURCE_IP IpAddresses: type: array items: $ref: '#/components/schemas/IpAddress' minItems: 0 maxItems: 2 IdempotencyToken: type: string maxLength: 255 Tags: type: array items: $ref: '#/components/schemas/Tag' CustomRoutingAccelerator: type: object properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the custom routing 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 custom routing accelerator, the value must be IPV4. Enabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description: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 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/CustomRoutingAcceleratorStatus' - 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. description: Attributes of a custom routing accelerator. CustomRoutingDestinationConfigurations: type: array items: $ref: '#/components/schemas/CustomRoutingDestinationConfiguration' minItems: 1 maxItems: 100 CustomRoutingEndpointGroup: type: object properties: EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. EndpointGroupRegion: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Web Services Region where the endpoint group is located. DestinationDescriptions: allOf: - $ref: '#/components/schemas/CustomRoutingDestinationDescriptions' - description: For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on. EndpointDescriptions: allOf: - $ref: '#/components/schemas/CustomRoutingEndpointDescriptions' - description: For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on. description: 'A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener. ' PortRanges: type: array items: $ref: '#/components/schemas/PortRange' minItems: 1 maxItems: 10 CustomRoutingListener: type: object properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener. PortRanges: allOf: - $ref: '#/components/schemas/PortRanges' - description:The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
description: A complex type for a listener for a custom routing accelerator. TrafficDialPercentage: type: number format: float minimum: 0 maximum: 100 HealthCheckPort: type: integer minimum: 1 maximum: 65535 HealthCheckProtocol: type: string enum: - TCP - HTTP - HTTPS HealthCheckPath: type: string pattern: ^/[-a-zA-Z0-9@:%_\\+.~#?&/=]*$ maxLength: 255 HealthCheckIntervalSeconds: type: integer minimum: 10 maximum: 30 ThresholdCount: type: integer minimum: 1 maximum: 10 PortOverrides: type: array items: $ref: '#/components/schemas/PortOverride' minItems: 0 maxItems: 10 EndpointGroup: type: object properties: EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. EndpointGroupRegion: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Web Services Region where the endpoint group is located. EndpointDescriptions: allOf: - $ref: '#/components/schemas/EndpointDescriptions' - description: The list of endpoint objects. TrafficDialPercentage: allOf: - $ref: '#/components/schemas/TrafficDialPercentage' - description:The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
HealthCheckPort: allOf: - $ref: '#/components/schemas/HealthCheckPort' - description:The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
HealthCheckProtocol: allOf: - $ref: '#/components/schemas/HealthCheckProtocol' - description: The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP. HealthCheckPath: allOf: - $ref: '#/components/schemas/HealthCheckPath' - description: If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/). HealthCheckIntervalSeconds: allOf: - $ref: '#/components/schemas/HealthCheckIntervalSeconds' - description: The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30. ThresholdCount: allOf: - $ref: '#/components/schemas/ThresholdCount' - description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3. PortOverrides: allOf: - $ref: '#/components/schemas/PortOverrides' - description: 'Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on. ' description: 'A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener. ' Protocol: type: string enum: - TCP - UDP Listener: type: object properties: ListenerArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the listener. PortRanges: allOf: - $ref: '#/components/schemas/PortRanges' - description: The list of port ranges for the connections from clients to the accelerator. Protocol: allOf: - $ref: '#/components/schemas/Protocol' - description: The protocol for the connections from clients to the accelerator. ClientAffinity: allOf: - $ref: '#/components/schemas/ClientAffinity' - description:Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.
Global Accelerator uses a consistent-flow hashing algorithm to choose the
optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP
address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global
Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same
endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source
(client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be
specified.
For more information, see Flow logs in the Global Accelerator Developer Guide.
FlowLogsS3Bucket: allOf: - $ref: '#/components/schemas/GenericString' - description: The name of the Amazon S3 bucket for the flow logs. Attribute is required ifFlowLogsEnabled is true. The bucket must exist and have a bucket policy
that grants Global Accelerator permission to write to the bucket.
FlowLogsS3Prefix:
allOf:
- $ref: '#/components/schemas/GenericString'
- description: The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
description: Attributes of a custom routing accelerator. CustomRoutingAccelerators: type: array items: $ref: '#/components/schemas/CustomRoutingAccelerator' PortNumber: type: integer minimum: 1 maximum: 65535 CustomRoutingProtocols: type: array items: $ref: '#/components/schemas/CustomRoutingProtocol' minItems: 1 maxItems: 2 CustomRoutingDestinationConfiguration: type: object required: - FromPort - ToPort - Protocols properties: FromPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator. ToPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator. Protocols: allOf: - $ref: '#/components/schemas/CustomRoutingProtocols' - description: The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP. description: For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on. Protocols: type: array items: $ref: '#/components/schemas/Protocol' CustomRoutingDestinationDescription: type: object properties: FromPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator. ToPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator. Protocols: allOf: - $ref: '#/components/schemas/Protocols' - description: The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP. description: For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on. CustomRoutingDestinationDescriptions: type: array items: $ref: '#/components/schemas/CustomRoutingDestinationDescription' CustomRoutingDestinationTrafficState: type: string enum: - ALLOW - DENY CustomRoutingEndpointConfiguration: type: object properties: EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description: 'An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. ' description: The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs. CustomRoutingEndpointDescription: type: object properties: EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description: 'An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. ' description: A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets. CustomRoutingEndpointGroups: type: array items: $ref: '#/components/schemas/CustomRoutingEndpointGroup' CustomRoutingListeners: type: array items: $ref: '#/components/schemas/CustomRoutingListener' CustomRoutingProtocol: type: string enum: - TCP - UDP IpAddress: type: string maxLength: 45 SocketAddresses: type: array items: $ref: '#/components/schemas/SocketAddress' SocketAddress: type: object properties: IpAddress: allOf: - $ref: '#/components/schemas/GenericString' - description: The IP address for the socket address. Port: allOf: - $ref: '#/components/schemas/PortNumber' - description: The port for the socket address. description: An IP address/port combination. DestinationPortMapping: type: object properties: AcceleratorArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for. AcceleratorSocketAddresses: allOf: - $ref: '#/components/schemas/SocketAddresses' - description: The IP address/port combinations (sockets) that map to a given destination socket address. EndpointGroupArn: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the endpoint group. EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description: The ID for the virtual private cloud (VPC) subnet. EndpointGroupRegion: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Web Services Region for the endpoint group. DestinationSocketAddress: allOf: - $ref: '#/components/schemas/SocketAddress' - description: The endpoint IP address/port combination for traffic received on the accelerator socket address. IpAddressType: allOf: - $ref: '#/components/schemas/IpAddressType' - description: The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4. DestinationTrafficState: allOf: - $ref: '#/components/schemas/CustomRoutingDestinationTrafficState' - description: Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination. description: The port mappings for a specified endpoint IP address (destination). DestinationPortMappings: type: array items: $ref: '#/components/schemas/DestinationPortMapping' EndpointWeight: type: integer minimum: 0 maximum: 255 EndpointConfiguration: type: object properties: EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description:An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.
An Application Load Balancer can be either internal or internet-facing.
Weight: allOf: - $ref: '#/components/schemas/EndpointWeight' - description: The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide. ClientIPPreservationEnabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators.
If the
value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the
accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
description: A complex type for endpoints. A resource must be valid and active when you add it as an endpoint. HealthState: type: string enum: - INITIAL - HEALTHY - UNHEALTHY EndpointDescription: type: object properties: EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description:An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Weight: allOf: - $ref: '#/components/schemas/EndpointWeight' - description: 'The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide. ' HealthState: allOf: - $ref: '#/components/schemas/HealthState' - description: The health status of the endpoint. HealthReason: allOf: - $ref: '#/components/schemas/GenericString' - description: Returns a null result. ClientIPPreservationEnabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators.
If the
value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the
accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
description: A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers. EndpointGroups: type: array items: $ref: '#/components/schemas/EndpointGroup' EndpointIdentifier: type: object required: - EndpointId properties: EndpointId: allOf: - $ref: '#/components/schemas/GenericString' - description:An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
ClientIPPreservationEnabled: allOf: - $ref: '#/components/schemas/GenericBoolean' - description:Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.
If the value is set to true, the client's IP address is
preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.
Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
PortRange: type: object properties: FromPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The first port in the range of ports, inclusive. ToPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The last port in the range of ports, inclusive. description: A complex type for a range of ports for a listener. TagKey: type: string minLength: 1 maxLength: 128 TagValue: type: string minLength: 0 maxLength: 256 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.
TagKeys:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 200
security:
- hmac: []