UpdateAccelerator - AWS Global Accelerator


Update an accelerator.


Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.

Request Syntax

{ "AcceleratorArn": "string", "Enabled": boolean, "IpAddressType": "string", "Name": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The Amazon Resource Name (ARN) of the accelerator to update.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes


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.

Type: Boolean

Required: No


The IP address type, which must be IPv4.

Type: String

Valid Values: IPV4

Required: No


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.

Type: String

Length Constraints: Maximum length of 255.

Required: No

Response Syntax

{ "Accelerator": { "AcceleratorArn": "string", "CreatedTime": number, "DnsName": "string", "Enabled": boolean, "IpAddressType": "string", "IpSets": [ { "IpAddresses": [ "string" ], "IpFamily": "string" } ], "LastModifiedTime": number, "Name": "string", "Status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Information about the updated accelerator.

Type: Accelerator object


For information about the errors that are common to all actions, see Common Errors.


The accelerator that you specified doesn't exist.

HTTP Status Code: 400


There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400


An argument that you specified is invalid.

HTTP Status Code: 400


Update an accelerator

The following is an example for updating an accelerator to change the name.

aws globalaccelerator update-accelerator --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh --name ExampleAcceleratorNew --region us-west-2
{ "Accelerator":{ "AcceleratorArn":"arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType":"IPV4", "Name":"ExampleAcceleratorNew", "Enabled":true, "Status":"IN_PROGRESS", "IpSets":[ { "IpAddresses":[ "", "" ], "IpFamily":"IPv4" } ], "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", "CreatedTime":1232394847.0, "LastModifiedTime":1232395654.0 } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: