Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DescribeVpcsCommand

Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeVpcsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeVpcsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeVpcsRequest
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  VpcIds: [ // VpcIdStringList
    "STRING_VALUE",
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  DryRun: true || false,
};
const command = new DescribeVpcsCommand(input);
const response = await client.send(command);
// { // DescribeVpcsResult
//   NextToken: "STRING_VALUE",
//   Vpcs: [ // VpcList
//     { // Vpc
//       OwnerId: "STRING_VALUE",
//       InstanceTenancy: "default" || "dedicated" || "host",
//       Ipv6CidrBlockAssociationSet: [ // VpcIpv6CidrBlockAssociationSet
//         { // VpcIpv6CidrBlockAssociation
//           AssociationId: "STRING_VALUE",
//           Ipv6CidrBlock: "STRING_VALUE",
//           Ipv6CidrBlockState: { // VpcCidrBlockState
//             State: "associating" || "associated" || "disassociating" || "disassociated" || "failing" || "failed",
//             StatusMessage: "STRING_VALUE",
//           },
//           NetworkBorderGroup: "STRING_VALUE",
//           Ipv6Pool: "STRING_VALUE",
//           Ipv6AddressAttribute: "public" || "private",
//           IpSource: "amazon" || "byoip" || "none",
//         },
//       ],
//       CidrBlockAssociationSet: [ // VpcCidrBlockAssociationSet
//         { // VpcCidrBlockAssociation
//           AssociationId: "STRING_VALUE",
//           CidrBlock: "STRING_VALUE",
//           CidrBlockState: {
//             State: "associating" || "associated" || "disassociating" || "disassociated" || "failing" || "failed",
//             StatusMessage: "STRING_VALUE",
//           },
//         },
//       ],
//       IsDefault: true || false,
//       EncryptionControl: { // VpcEncryptionControl
//         VpcId: "STRING_VALUE",
//         VpcEncryptionControlId: "STRING_VALUE",
//         Mode: "monitor" || "enforce",
//         State: "enforce-in-progress" || "monitor-in-progress" || "enforce-failed" || "monitor-failed" || "deleting" || "deleted" || "available" || "creating" || "delete-failed",
//         StateMessage: "STRING_VALUE",
//         ResourceExclusions: { // VpcEncryptionControlExclusions
//           InternetGateway: { // VpcEncryptionControlExclusion
//             State: "enabling" || "enabled" || "disabling" || "disabled",
//             StateMessage: "STRING_VALUE",
//           },
//           EgressOnlyInternetGateway: {
//             State: "enabling" || "enabled" || "disabling" || "disabled",
//             StateMessage: "STRING_VALUE",
//           },
//           NatGateway: {
//             State: "enabling" || "enabled" || "disabling" || "disabled",
//             StateMessage: "STRING_VALUE",
//           },
//           VirtualPrivateGateway: {
//             State: "enabling" || "enabled" || "disabling" || "disabled",
//             StateMessage: "STRING_VALUE",
//           },
//           VpcPeering: {
//             State: "enabling" || "enabled" || "disabling" || "disabled",
//             StateMessage: "STRING_VALUE",
//           },
//         },
//         Tags: [ // TagList
//           { // Tag
//             Key: "STRING_VALUE",
//             Value: "STRING_VALUE",
//           },
//         ],
//       },
//       Tags: [
//         {
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       BlockPublicAccessStates: { // BlockPublicAccessStates
//         InternetGatewayBlockMode: "off" || "block-bidirectional" || "block-ingress",
//       },
//       VpcId: "STRING_VALUE",
//       State: "pending" || "available",
//       CidrBlock: "STRING_VALUE",
//       DhcpOptionsId: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

Loading code editor

DescribeVpcsCommand Input

See DescribeVpcsCommandInput for more details

Parameter	Type	Description
`DryRun`	`boolean \| undefined`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
`Filters`	`Filter[] \| undefined`	The filters. `cidr` - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, `/28`). `cidr-block-association.cidr-block` - An IPv4 CIDR block associated with the VPC. `cidr-block-association.association-id` - The association ID for an IPv4 CIDR block associated with the VPC. `cidr-block-association.state` - The state of an IPv4 CIDR block associated with the VPC. `dhcp-options-id` - The ID of a set of DHCP options. `ipv6-cidr-block-association.ipv6-cidr-block` - An IPv6 CIDR block associated with the VPC. `ipv6-cidr-block-association.ipv6-pool` - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. `ipv6-cidr-block-association.association-id` - The association ID for an IPv6 CIDR block associated with the VPC. `ipv6-cidr-block-association.state` - The state of an IPv6 CIDR block associated with the VPC. `is-default` - Indicates whether the VPC is the default VPC. `owner-id` - The ID of the Amazon Web Services account that owns the VPC. `state` - The state of the VPC (`pending` \| `available`). `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. `vpc-id` - The ID of the VPC.
`MaxResults`	`number \| undefined`	The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination .
`NextToken`	`string \| undefined`	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
`VpcIds`	`string[] \| undefined`	The IDs of the VPCs.

DescribeVpcsCommand Output

See DescribeVpcsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`NextToken`	`string \| undefined`	The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.
`Vpcs`	`Vpc[] \| undefined`	Information about the VPCs.

Throws

Name	Fault	Details
EC2ServiceException		Base exception class for all service exceptions from EC2 service.

Getting Started

References