Describe Subnets
ec2_describe_subnets | R Documentation |
Describes your subnets¶
Description¶
Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.
For more information, see Subnets in the Amazon VPC User Guide.
Usage¶
ec2_describe_subnets(Filters, SubnetIds, NextToken, MaxResults, DryRun)
Arguments¶
Filters |
The filters.
|
SubnetIds |
The IDs of the subnets. Default: Describes all your subnets. |
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. |
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
|
Value¶
A list with the following syntax:
list(
NextToken = "string",
Subnets = list(
list(
AvailabilityZoneId = "string",
EnableLniAtDeviceIndex = 123,
MapCustomerOwnedIpOnLaunch = TRUE|FALSE,
CustomerOwnedIpv4Pool = "string",
OwnerId = "string",
AssignIpv6AddressOnCreation = TRUE|FALSE,
Ipv6CidrBlockAssociationSet = list(
list(
AssociationId = "string",
Ipv6CidrBlock = "string",
Ipv6CidrBlockState = list(
State = "associating"|"associated"|"disassociating"|"disassociated"|"failing"|"failed",
StatusMessage = "string"
),
Ipv6AddressAttribute = "public"|"private",
IpSource = "amazon"|"byoip"|"none"
)
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
SubnetArn = "string",
OutpostArn = "string",
EnableDns64 = TRUE|FALSE,
Ipv6Native = TRUE|FALSE,
PrivateDnsNameOptionsOnLaunch = list(
HostnameType = "ip-name"|"resource-name",
EnableResourceNameDnsARecord = TRUE|FALSE,
EnableResourceNameDnsAAAARecord = TRUE|FALSE
),
BlockPublicAccessStates = list(
InternetGatewayBlockMode = "off"|"block-bidirectional"|"block-ingress"
),
SubnetId = "string",
State = "pending"|"available"|"unavailable",
VpcId = "string",
CidrBlock = "string",
AvailableIpAddressCount = 123,
AvailabilityZone = "string",
DefaultForAz = TRUE|FALSE,
MapPublicIpOnLaunch = TRUE|FALSE
)
)
)
Request syntax¶
svc$describe_subnets(
Filters = list(
list(
Name = "string",
Values = list(
"string"
)
)
),
SubnetIds = list(
"string"
),
NextToken = "string",
MaxResults = 123,
DryRun = TRUE|FALSE
)
Examples¶
## Not run:
# This example describes the subnets for the specified VPC.
svc$describe_subnets(
Filters = list(
list(
Name = "vpc-id",
Values = list(
"vpc-a01106c2"
)
)
)
)
## End(Not run)