AWS Global Accelerator
API Reference (API Version 2018-08-08)

DescribeAccelerator

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.

Request Syntax

{ "AcceleratorArn": "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.

AcceleratorArn

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax

{ "Accelerator": { "AcceleratorArn": "string", "CreatedTime": number, "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.

Accelerator

The description of the accelerator.

Type: Accelerator object

Errors

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

AcceleratorNotFoundException

The accelerator that you specified doesn't exist.

HTTP Status Code: 400

InternalServiceErrorException

There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400

InvalidArgumentException

An argument that you specified is invalid.

HTTP Status Code: 400

Example

Describe an accelerator

The following is an example for describing an accelerator and the response.

aws globalaccelerator describe-accelerator --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh --region us-west-2
{ "Accelerator": { "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", "IpAddressType": "IPV4", "Name": "ExampleAaccelerator", "Enabled": true, "Status": "IN_PROGRESS", "IpSets": [ { "IpAddresses": [ "192.0.2.250", "192.0.2.52" ], "IpFamily": "IPv4" } ], "CreatedTime": 1542394847.0, "LastModifiedTime": 1542395013.0 } }

See Also

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