Reference > PyDo > Library Reference > vpcs > list_peerings()

Was this page helpful?

Give Feedback

pydo.vpcs.list_peerings()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To list all of a VPC’s peerings, send a GET request to /v2/vpcs/$VPC_ID/peerings.

Parameters

Name	Type	Required	Description	Default Value
`vpc_id`	string	True	A unique identifier for a VPC.
`per_page`	integer	False	Number of items returned per page	20
`page`	integer	False	Which ‘page’ of paginated results to return.	1

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

The response will be a JSON object with a key called peerings. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering.

Click to expand an example response.

{
  "peerings": [
    {
      "id": "6b5c619c-359c-44ca-87e2-47e98170c01d",
      "name": "example-vpc-peering",
      "vpc_ids": [
        "997615ce-132d-4bae-9270-9ee21b395e5d",
        "e51aed59-3bb1-4a6a-8de0-9d1329e9c997"
      ],
      "created_at": "2024-01-09T20:44:32Z",
      "status": "ACTIVE"
    },
    {
      "id": "c212b274-911c-44cc-a117-23b7da4a2922",
      "name": "another-vpc-peering",
      "vpc_ids": [
        "5a100736-b085-4f69-81fd-feee325784bb",
        "c140286f-e6ce-4131-8b7b-df4590ce8d6a"
      ],
      "created_at": "2024-01-10T13:29:58Z",
      "status": "ACTIVE"
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}