paws.compute (version 0.1.12)

ec2_describe_subnets: Describes one or more of your subnets

Description

Describes one or more of your subnets.

For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

Usage

ec2_describe_subnets(Filters, SubnetIds, DryRun, NextToken, MaxResults)

Value

A list with the following syntax:

list(
  Subnets = list(
    list(
      AvailabilityZone = "string",
      AvailabilityZoneId = "string",
      AvailableIpAddressCount = 123,
      CidrBlock = "string",
      DefaultForAz = TRUE|FALSE,
      MapPublicIpOnLaunch = TRUE|FALSE,
      MapCustomerOwnedIpOnLaunch = TRUE|FALSE,
      CustomerOwnedIpv4Pool = "string",
      State = "pending"|"available",
      SubnetId = "string",
      VpcId = "string",
      OwnerId = "string",
      AssignIpv6AddressOnCreation = TRUE|FALSE,
      Ipv6CidrBlockAssociationSet = list(
        list(
          AssociationId = "string",
          Ipv6CidrBlock = "string",
          Ipv6CidrBlockState = list(
            State = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed",
            StatusMessage = "string"
          )
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      SubnetArn = "string",
      OutpostArn = "string"
    )
  ),
  NextToken = "string"
)

Arguments

Filters

One or more filters.

• availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

• available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

• cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

• default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name.

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• owner-id - The ID of the AWS account that owns the subnet.

• state - The state of the subnet (pending | available).

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• 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 for the subnet.

SubnetIds

One or more subnet IDs.

Default: Describes all your subnets.

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_subnets(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  SubnetIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)

Examples

if (FALSE) {
# This example describes the subnets for the specified VPC.
svc$describe_subnets(
  Filters = list(
    list(
      Name = "vpc-id",
      Values = list(
        "vpc-a01106c2"
      )
    )
  )
)
}