Retrieve VPCs
Suggest changes
GET /aws/ha/metadata/vpcs
Retrieves VPCs.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
region |
string |
query |
False |
|
roleArn |
string |
query |
False |
|
cloudProviderAccountId |
string |
query |
False |
Error
Status: Default, Default response| Name | Type | Required | Description |
|---|---|---|---|
vpcId |
string |
True |
The VPC identifier |
state |
string |
True |
The state of the VPC |
cidrBlock |
string |
True |
VPC Classless Inter-Domain Routing (CIDR) block |
tags |
array[VpcTagResponse] |
True |
VPC tags |
default |
boolean |
True |
Indicates whether the VPC is the default |
subnets |
array[SubnetResponse] |
True |
Subnets associated with the VPC |
securityGroups |
array[SecurityGroupResponse] |
True |
Security groups associated with the VPC |
tenancy |
string |
True |
Tenancy configuration for the VPC |
Definitions
See Definitions
VpcTagResponse
| Name | Type | Required | Description |
|---|---|---|---|
key |
string |
True |
VPC tag key |
value |
string |
True |
VPC tag value |
SubnetResponse
| Name | Type | Required | Description |
|---|---|---|---|
subnetId |
string |
True |
Subnet ID |
cidr |
string |
True |
CIDR |
subnetName |
string |
False |
Subnet name |
availabilityZone |
string |
True |
Availability zone |
availableIps |
integer |
True |
The number of available IP addresses on the subnet |
minimumRequiredIps |
integer |
True |
The minimum required IP addresses for the Cloud Volumes ONTAP create operation
|
outpostArn |
string |
False |
The ARN of the outpost |
SecurityGroupResponse
| Name | Type | Required | Description |
|---|---|---|---|
securityGroupId |
string |
True |
Security group ID |
description |
string |
True |
Description |
name |
string |
True |
Specifies the name |