Skip to main content

Retrieve AWS private links

Contributors

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/privateLink

Retrieves a list of AWS private links from a specified region that belongs to a specified AWS account ID.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

accountId

string

path

True

regionCode

string

path

True

awsAccountId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

privateLink

array[privateLink]

False

Example response
{
  "privateLink": [
    {
      "vpc-name": "string",
      "vpc-id": "string",
      "private-endpoint-id": "string",
      "private-endpoint-name": "string"
    }
  ]
}

Definitions

See Definitions
Name Type Required Description

vpc-name

string

False

vpc-id

string

False

private-endpoint-id

string

False

private-endpoint-name

string

False