Returns a list of DBSubnetGroup descriptions¶

Description¶

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Usage¶

docdb_describe_db_subnet_groups(DBSubnetGroupName, Filters, MaxRecords,
  Marker)

Arguments¶

• DBSubnetGroupName

  The name of the subnet group to return details for.

• Filters

  This parameter is not currently supported.

• MaxRecords

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

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker

  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value¶

A list with the following syntax:

list(
  Marker = "string",
  DBSubnetGroups = list(
    list(
      DBSubnetGroupName = "string",
      DBSubnetGroupDescription = "string",
      VpcId = "string",
      SubnetGroupStatus = "string",
      Subnets = list(
        list(
          SubnetIdentifier = "string",
          SubnetAvailabilityZone = list(
            Name = "string"
          ),
          SubnetStatus = "string"
        )
      ),
      DBSubnetGroupArn = "string",
      SupportedNetworkTypes = list(
        "string"
      )
    )
  )
)

Request syntax¶

svc$describe_db_subnet_groups(
  DBSubnetGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)