Skip to content

Describe Vpcs

ec2_describe_vpcs R Documentation

Describes your VPCs

Description

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.

Usage

ec2_describe_vpcs(Filters, VpcIds, DryRun, NextToken, MaxResults)

Arguments

Filters

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:\<key\> - 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.

VpcIds

The IDs of the VPCs.

DryRun

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.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

MaxResults

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.

Value

A list with the following syntax: 

list(
  Vpcs = list(
    list(
      CidrBlock = "string",
      DhcpOptionsId = "string",
      State = "pending"|"available",
      VpcId = "string",
      OwnerId = "string",
      InstanceTenancy = "default"|"dedicated"|"host",
      Ipv6CidrBlockAssociationSet = list(
        list(
          AssociationId = "string",
          Ipv6CidrBlock = "string",
          Ipv6CidrBlockState = list(
            State = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed",
            StatusMessage = "string"
          ),
          NetworkBorderGroup = "string",
          Ipv6Pool = "string",
          Ipv6AddressAttribute = "public"|"private",
          IpSource = "amazon"|"byoip"|"none"
        )
      ),
      CidrBlockAssociationSet = list(
        list(
          AssociationId = "string",
          CidrBlock = "string",
          CidrBlockState = list(
            State = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed",
            StatusMessage = "string"
          )
        )
      ),
      IsDefault = TRUE|FALSE,
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_vpcs(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  VpcIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# This example describes the specified VPC.
svc$describe_vpcs(
  VpcIds = list(
    "vpc-a01106c2"
  )
)

## End(Not run)