This is the Global Accelerator API Reference. This guide is for developers who need detailed information about\nGlobal Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the\nGlobal Accelerator Developer Guide.
\nGlobal Accelerator is a service in which you create accelerators to improve the performance\nof your applications for local and global users. Depending on the type of accelerator you choose, you can\ngain additional benefits.
\nBy using a standard accelerator, you can improve availability of your internet applications\nthat are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services\nglobal network.
\nFor other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you\ncan use application logic to directly map one or more users to a specific endpoint among many endpoints.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the\nUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\non Amazon Web Services CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses\nare anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,\nGlobal Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.\nWith a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure\nthese entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP).
\nFor a standard accelerator,\nthey distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases\nthe availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,\nAmazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing\naccelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that\nare virtual private cloud (VPC) subnets.
\nThe static IP addresses remain assigned to your accelerator for as long as it exists, even if you\ndisable the accelerator and it no longer accepts or routes traffic. However, when you\ndelete an accelerator, you lose the static IP addresses that\nare assigned to it, so you can no longer route traffic by using them. You can use\nIAM policies like tag-based permissions with Global Accelerator to limit the users who have\npermissions to delete an accelerator. For more information, see Tag-based policies.
\nFor standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based\non health, client location, and policies that you configure. The service reacts instantly to\nchanges in health or configuration to ensure that internet traffic from clients is always\ndirected to healthy endpoints.
\nFor more information about understanding and using Global Accelerator, see the\nGlobal Accelerator Developer Guide.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-global-accelerator`\n- `yarn add @aws-sdk/client-global-accelerator`\n- `pnpm add @aws-sdk/client-global-accelerator`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `GlobalAcceleratorClient` and\nthe commands you need, for example `ListAcceleratorsCommand`:\n\n```js\n// ES5 example\nconst { GlobalAcceleratorClient, ListAcceleratorsCommand } = require(\"@aws-sdk/client-global-accelerator\");\n```\n\n```ts\n// ES6+ example\nimport { GlobalAcceleratorClient, ListAcceleratorsCommand } from \"@aws-sdk/client-global-accelerator\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new GlobalAcceleratorClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListAcceleratorsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`GlobalAccelerator` extends `GlobalAcceleratorClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`GlobalAcceleratorClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { GlobalAccelerator } from \"@aws-sdk/client-global-accelerator\";\n\nconst client = new GlobalAccelerator({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listAccelerators(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listAccelerators(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listAccelerators(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-global-accelerator` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n