@aws-sdk/client-global-accelerator 3.137.0 → 3.142.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +23 -120
  3. package/dist-cjs/models/models_0.js +13 -3
  4. package/dist-cjs/protocols/Aws_json1_1.js +264 -412
  5. package/dist-es/models/models_0.js +7 -0
  6. package/dist-es/protocols/Aws_json1_1.js +433 -437
  7. package/dist-types/GlobalAccelerator.d.ts +66 -158
  8. package/dist-types/GlobalAcceleratorClient.d.ts +25 -120
  9. package/dist-types/commands/AdvertiseByoipCidrCommand.d.ts +4 -4
  10. package/dist-types/commands/CreateAcceleratorCommand.d.ts +3 -2
  11. package/dist-types/commands/CreateCustomRoutingAcceleratorCommand.d.ts +4 -3
  12. package/dist-types/commands/CreateCustomRoutingEndpointGroupCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateEndpointGroupCommand.d.ts +1 -1
  14. package/dist-types/commands/DeleteAcceleratorCommand.d.ts +4 -4
  15. package/dist-types/commands/DeleteCustomRoutingAcceleratorCommand.d.ts +3 -3
  16. package/dist-types/commands/DeprovisionByoipCidrCommand.d.ts +3 -3
  17. package/dist-types/commands/ListAcceleratorsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListCustomRoutingAcceleratorsCommand.d.ts +1 -1
  19. package/dist-types/commands/ListCustomRoutingPortMappingsCommand.d.ts +4 -4
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  21. package/dist-types/commands/ProvisionByoipCidrCommand.d.ts +3 -3
  22. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  23. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  24. package/dist-types/commands/UpdateAcceleratorCommand.d.ts +3 -2
  25. package/dist-types/commands/WithdrawByoipCidrCommand.d.ts +3 -3
  26. package/dist-types/models/models_0.d.ts +188 -129
  27. package/dist-types/ts3.4/models/models_0.d.ts +20 -0
  28. package/package.json +6 -6
@@ -10,8 +10,9 @@ export interface CreateAcceleratorCommandOutput extends CreateAcceleratorRespons
10
10
  * <p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic
11
11
  * to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. </p>
12
12
  * <important>
13
- * <p>Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the
14
- * US West (Oregon) Region to create or update accelerators.</p>
13
+ * <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
14
+ * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
15
+ * on AWS CLI commands.</p>
15
16
  * </important>
16
17
  * @example
17
18
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,14 +8,15 @@ export interface CreateCustomRoutingAcceleratorCommandOutput extends CreateCusto
8
8
  }
9
9
  /**
10
10
  * <p>Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands
11
- * of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.</p>
11
+ * of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.</p>
12
12
  * <p>Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive
13
13
  * traffic. To enable all destinations to receive traffic, or to specify individual port
14
14
  * mappings that can receive traffic, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html">
15
15
  * AllowCustomRoutingTraffic</a> operation.</p>
16
16
  * <important>
17
- * <p>Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the
18
- * US West (Oregon) Region to create or update accelerators.</p>
17
+ * <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
18
+ * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
19
+ * on AWS CLI commands.</p>
19
20
  * </important>
20
21
  * @example
21
22
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,7 +8,7 @@ export interface CreateCustomRoutingEndpointGroupCommandOutput extends CreateCus
8
8
  }
9
9
  /**
10
10
  * <p>Create an endpoint group for the specified listener for a custom routing accelerator.
11
- * An endpoint group is a collection of endpoints in one AWS
11
+ * An endpoint group is a collection of endpoints in one Amazon Web Services
12
12
  * Region. </p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,7 @@ export interface CreateEndpointGroupCommandInput extends CreateEndpointGroupRequ
7
7
  export interface CreateEndpointGroupCommandOutput extends CreateEndpointGroupResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS
10
+ * <p>Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services
11
11
  * Region. A resource must be valid and active when you add it as an endpoint.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
@@ -9,17 +9,17 @@ export interface DeleteAcceleratorCommandOutput extends __MetadataBearer {
9
9
  /**
10
10
  * <p>Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources
11
11
  * (listeners and endpoint groups). To disable the accelerator, update the accelerator to set <code>Enabled</code> to false.</p>
12
- * <important>
12
+ * <important>
13
13
  * <p>When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
14
- * Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
14
+ * Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
15
15
  * </p>
16
16
  * <p>The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and
17
17
  * it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the
18
18
  * static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.
19
19
  * As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You
20
20
  * can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information,
21
- * see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html">Authentication and Access Control</a> in
22
- * the <i>AWS Global Accelerator Developer Guide</i>.</p>
21
+ * see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html">Identity and access management</a> in
22
+ * the <i>Global Accelerator Developer Guide</i>.</p>
23
23
  * </important>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
@@ -9,7 +9,7 @@ export interface DeleteCustomRoutingAcceleratorCommandOutput extends __MetadataB
9
9
  /**
10
10
  * <p>Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources
11
11
  * (listeners and endpoint groups). To disable the accelerator, update the accelerator to set <code>Enabled</code> to false.</p>
12
- * <important>
12
+ * <important>
13
13
  * <p>When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
14
14
  * </p>
15
15
  * <p>The IP
@@ -18,8 +18,8 @@ export interface DeleteCustomRoutingAcceleratorCommandOutput extends __MetadataB
18
18
  * static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.
19
19
  * As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You
20
20
  * can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information,
21
- * see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html">Authentication and Access Control</a> in
22
- * the <i>AWS Global Accelerator Developer Guide</i>.</p>
21
+ * see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html">Identity and access management</a> in
22
+ * the <i>Global Accelerator Developer Guide</i>.</p>
23
23
  * </important>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,13 +7,13 @@ export interface DeprovisionByoipCidrCommandInput extends DeprovisionByoipCidrRe
7
7
  export interface DeprovisionByoipCidrCommandOutput extends DeprovisionByoipCidrResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Releases the specified address range that you provisioned to use with your AWS resources
10
+ * <p>Releases the specified address range that you provisioned to use with your Amazon Web Services resources
11
11
  * through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. </p>
12
12
  * <p>Before you can release an address range, you must stop advertising it by using <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">WithdrawByoipCidr</a> and you must not have
13
13
  * any accelerators that are using static IP addresses allocated from its address range.
14
14
  * </p>
15
- * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring Your Own
16
- * IP Addresses (BYOIP)</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>
15
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
16
+ * your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -7,7 +7,7 @@ export interface ListAcceleratorsCommandInput extends ListAcceleratorsRequest {
7
7
  export interface ListAcceleratorsCommandOutput extends ListAcceleratorsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>List the accelerators for an AWS account. </p>
10
+ * <p>List the accelerators for an Amazon Web Services account. </p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface ListCustomRoutingAcceleratorsCommandInput extends ListCustomRou
7
7
  export interface ListCustomRoutingAcceleratorsCommandOutput extends ListCustomRoutingAcceleratorsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>List the custom routing accelerators for an AWS account. </p>
10
+ * <p>List the custom routing accelerators for an Amazon Web Services account. </p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -10,10 +10,10 @@ export interface ListCustomRoutingPortMappingsCommandOutput extends ListCustomRo
10
10
  * <p>Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance
11
11
  * IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.
12
12
  * For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port
13
- * mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. </p>
14
- * <p>If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to
15
- * your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances
16
- * in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.</p>
13
+ * mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. </p>
14
+ * <p>If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to
15
+ * your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances
16
+ * in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.</p>
17
17
  * <p>The mappings also include a flag for each destination denoting which destination IP addresses and
18
18
  * ports are allowed or denied traffic.</p>
19
19
  * @example
@@ -9,7 +9,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
9
9
  /**
10
10
  * <p>List all tags for an accelerator. </p>
11
11
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
12
- * in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>. </p>
12
+ * in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>. </p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -7,12 +7,12 @@ export interface ProvisionByoipCidrCommandInput extends ProvisionByoipCidrReques
7
7
  export interface ProvisionByoipCidrCommandOutput extends ProvisionByoipCidrResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Provisions an IP address range to use with your AWS resources through bring your own IP
10
+ * <p>Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP
11
11
  * addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned,
12
12
  * it is ready to be advertised using <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html">
13
13
  * AdvertiseByoipCidr</a>.</p>
14
- * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring Your Own
15
- * IP Addresses (BYOIP)</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>
14
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
15
+ * IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -9,7 +9,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
9
9
  /**
10
10
  * <p>Add tags to an accelerator resource. </p>
11
11
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
12
- * in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>. </p>
12
+ * in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>. </p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -10,7 +10,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
10
10
  * <p>Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.
11
11
  * The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.</p>
12
12
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
13
- * in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>
13
+ * in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -10,8 +10,9 @@ export interface UpdateAcceleratorCommandOutput extends UpdateAcceleratorRespons
10
10
  * <p>Update an accelerator. </p>
11
11
  *
12
12
  * <important>
13
- * <p>Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the
14
- * US West (Oregon) Region to create or update accelerators.</p>
13
+ * <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
14
+ * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
15
+ * on AWS CLI commands.</p>
15
16
  * </important>
16
17
  * @example
17
18
  * Use a bare-bones client and the command you need to make an API call.
@@ -10,10 +10,10 @@ export interface WithdrawByoipCidrCommandOutput extends WithdrawByoipCidrRespons
10
10
  * <p>Stops advertising an address range that is provisioned as an address pool.
11
11
  * You can perform this operation at most once every 10 seconds, even if you specify different address
12
12
  * ranges each time.</p>
13
- * <p>It can take a few minutes before traffic to the specified addresses stops routing to AWS because of
13
+ * <p>It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of
14
14
  * propagation delays.</p>
15
- * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring Your Own
16
- * IP Addresses (BYOIP)</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>
15
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
16
+ * IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript