ListCustomRoutingAccelerators
List the custom routing accelerators for an AWS account.
Request Syntax
{
"MaxResults": number,
"NextToken": "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.
- MaxResults
-
The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token for the next set of results. You receive this token from a previous call.
Type: String
Length Constraints: Maximum length of 255.
Required: No
Response Syntax
{
"Accelerators": [
{
"AcceleratorArn": "string",
"CreatedTime": number,
"DnsName": "string",
"Enabled": boolean,
"IpAddressType": "string",
"IpSets": [
{
"IpAddresses": [ "string" ],
"IpAddressFamily": "string",
"IpFamily": "string"
}
],
"LastModifiedTime": number,
"Name": "string",
"Status": "string"
}
],
"NextToken": "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.
- Accelerators
-
The list of custom routing accelerators for a customer account.
Type: Array of CustomRoutingAccelerator objects
- NextToken
-
The token for the next set of results. You receive this token from a previous call.
Type: String
Length Constraints: Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- InvalidNextTokenException
-
There isn't another item to return.
HTTP Status Code: 400
Examples
List custom routing accelerators
The following is an example for listing the custom routing accelerators for an AWS account, and the response.
aws globalaccelerator list-custom-routing-accelerators --region us-west-2
{
"Accelerators": [
{
"AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/5555abcd-abcd-5555-abcd-5555EXAMPLE1",
"Name": "TestAccelerator",
"IpAddressType": "IPV4",
"Enabled": true,
"IpSets": [
{
"IpFamily": "IPv4",
"IpAddresses": [
"192.0.2.250",
"198.51.100.52"
]
}
],
"DnsName": "5a5a5a5a5a5a5a5a.awsglobalaccelerator.com",
"Status": "DEPLOYED",
"CreatedTime": 1552424416.0,
"LastModifiedTime": 1569375641.0
},
{
"AcceleratorArn": "arn:aws:globalaccelerator::888888888888:accelerator/8888abcd-abcd-8888-abcd-8888EXAMPLE2",
"Name": "ExampleAccelerator",
"IpAddressType": "IPV4",
"Enabled": true,
"IpSets": [
{
"IpFamily": "IPv4",
"IpAddresses": [
"192.0.2.100",
"198.51.100.10"
]
}
],
"DnsName": "6a6a6a6a6a6a6a.awsglobalaccelerator.com",
"Status": "DEPLOYED",
"CreatedTime": 1575585564.0,
"LastModifiedTime": 1579809243.0
},
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
