paws.compute (version 0.1.12)

ec2_describe_vpcs: Describes one or more of your VPCs

Description

Describes one or more of your VPCs.

Usage

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

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"
        )
      ),
      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"
)

Arguments

Filters

One or more 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.

• isDefault - Indicates whether the VPC is the default VPC.

• owner-id - The ID of the AWS 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

One or more VPC IDs.

Default: Describes all your 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 for the next page of results.

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Request syntax

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

Examples

if (FALSE) {
# This example describes the specified VPC.
svc$describe_vpcs(
  VpcIds = list(
    "vpc-a01106c2"
  )
)
}