Describe Subnet Groups

dax_describe_subnet_groups

R Documentation

Returns a list of subnet group descriptions¶

Description¶

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

Usage¶

dax_describe_subnet_groups(SubnetGroupNames, MaxResults, NextToken)

Arguments¶

SubnetGroupNames

The name of the subnet group.

MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  SubnetGroups = list(
    list(
      SubnetGroupName = "string",
      Description = "string",
      VpcId = "string",
      Subnets = list(
        list(
          SubnetIdentifier = "string",
          SubnetAvailabilityZone = "string"
        )
      )
    )
  )
)

Request syntax¶

svc$describe_subnet_groups(
  SubnetGroupNames = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)