Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListByoipCidrs

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

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 maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token for the next page of results.

Type: String

Length Constraints: Maximum length of 255.

Required: No

Response Syntax


{
   "ByoipCidrs": [ 
      { 
         "Cidr": "string",
         "Events": [ 
            { 
               "Message": "string",
               "Timestamp": number
            }
         ],
         "State": "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.

ByoipCidrs

Information about your address ranges.

Type: Array of ByoipCidr objects

NextToken

The token for the next page of results.

Type: String

Length Constraints: Maximum length of 255.

Errors

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

AccessDeniedException

You don't have access permission.

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

InvalidNextTokenException

There isn't another item to return.

HTTP Status Code: 400

Examples

List BYOIP CIDR addresses

The following is an example of listing BYOIP CIDR addresses and the response.


aws globalaccelerator list-byoip-cidrs


{
    "ByoipCidrs": [
        {
            "Cidr": "198.51.100.0/24",
            "State": "DEPROVISIONED",
            "Events": [
                {
                    "Message": "CIDR is deprovisioned",
                    "Timestamp": 1584977476.0
                },
                {
                    "Message": "Initiated CIDR deprovisioning",
                    "Timestamp": 1584977440.0
                },
                {
                    "Message": "CIDR is no longer advertising",
                    "Timestamp": 1584977429.0
                },
                {
                    "Message": "Initiated CIDR withdrawal",
                    "Timestamp": 1584977348.0
                },
                {
                    "Message": "CIDR is advertising",
                    "Timestamp": 1584977334.0
                },
                {
                    "Message": "Initiated CIDR advertisement",
                    "Timestamp": 1584977298.0
                },
                {
                    "Message": "CIDR is provisioned",
                    "Timestamp": 1584977280.0
                },
                {
                    "Message": "Initiated CIDR provisioning",
                    "Timestamp": 1584977239.0
                }
            ]
        }
        {
            "Cidr": "203.0.113.25/24",
            "State": "READY",
            "Events": [
                {
                    "Message": "CIDR is provisioned",
                    "Timestamp": 1584977802.0
                },
                {
                    "Message": "Initiated CIDR provisioning",
                    "Timestamp": 1584977367.0
                }
            ]
        }
    ]
}