Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPeerings

Lists the peerings for a core network.

Request Syntax


GET /peerings?coreNetworkId=CoreNetworkId&edgeLocation=EdgeLocation&maxResults=MaxResults&nextToken=NextToken&peeringType=PeeringType&state=State HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CoreNetworkId

The ID of a core network.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: ^core-network-([0-9a-f]{8,17})$

EdgeLocation

Returns a list edge locations for the

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [\s\S]*

MaxResults

The maximum number of results to return.

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

NextToken

The token for the next page of results.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\s\S]*

PeeringType

Returns a list of a peering requests.

Valid Values: TRANSIT_GATEWAY

State

Returns a list of the peering request states.

Valid Values: CREATING | FAILED | AVAILABLE | DELETING

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Peerings": [ 
      { 
         "CoreNetworkArn": "string",
         "CoreNetworkId": "string",
         "CreatedAt": number,
         "EdgeLocation": "string",
         "OwnerAccountId": "string",
         "PeeringId": "string",
         "PeeringType": "string",
         "ResourceArn": "string",
         "State": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "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.

NextToken

The token for the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\s\S]*

Peerings

Lists the transit gateway peerings for the ListPeerings request.

Type: Array of Peering objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400